Skip to content

Commit 63cb523

Browse files
lextmlextm
committed
Added support page. Revised references.
1 parent b45de56 commit 63cb523

File tree

8 files changed

+157
-10
lines changed

8 files changed

+157
-10
lines changed

Diff for: ‎.python-version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.11
1+
3.12

Diff for: ‎.vscode/settings.json

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
{
2-
"esbonio.sphinx.confDir": "${workspaceFolder}/docs/source",
2+
"editor.rulers": [
3+
80
4+
]
35
}

Diff for: ‎docs/source/history.rst

+7
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,10 @@ LeXtudio Inc. announced its own plan to revive the ecosystem on GitHub [10]_.
6868
.. [8] https://github.com/etingof?tab=overview&from=2020-12-01&to=2020-12-31
6969
.. [9] https://github.com/pyasn1
7070
.. [10] https://github.com/etingof/pysnmp/issues/429
71+
72+
References
73+
----------
74+
75+
- :doc:`/support`
76+
- `PySNMP Quick Start <https://www.pysnmp.com/pysnmp/quick-start>`_
77+
- :doc:`/license`

Diff for: ‎docs/source/includes/_links.rst

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. toctree::
2+
3+
.. _LeXtudio Inc.: https://www.lextudio.com
4+
.. _PySNMP PyPI package: http://pypi.python.org/pypi/pysnmp-lextudio
5+
.. _PySNMP GitHub repository: https://github.com/lextudio/pysnmp
6+
.. _GitHub issue: https://github.com/lextudio/pysnmp/issues/new
7+
.. _Stack Overflow: http://stackoverflow.com/questions/tagged/pysnmp
8+
.. _demo.pysnmp.com: https://www.pysnmp.com/snmp-simulation-service#
9+
.. _mibs.pysnmp.com: https://mibs.pysnmp.com/
10+
.. _PySMI: https://www.pysnmp.com/pysmi/
11+
.. _SNMP Proxy Forwarder: https://www.pysnmp.com/snmpfwd/
12+
.. _snmpsim: https://www.pysnmp.com/snmpsim/
13+
.. _PyASN1: https://pyasn1.readthedocs.io/
14+
.. _mibdump: https://www.pysnmp.com/pysmi/docs/mibdump
15+
.. _command line tools: https://www.pysnmp.com/snmpclitools/
16+
.. _Python: https://www.python.org/
17+
.. _SNMP: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol
18+
.. _PSF: https://www.python.org/psf/
19+
.. _ASN.1: https://en.wikipedia.org/wiki/Abstract_Syntax_Notation_One
20+
.. _RFC3413: https://www.ietf.org/rfc/rfc3413.txt
21+
.. _RFC3418: https://www.ietf.org/rfc/rfc3418.txt
22+
.. _pyenv: https://github.com/pyenv/pyenv
23+
.. _pyenv-win: https://github.com/pyenv-win/pyenv-win
24+
.. _Wireshark: https://www.wireshark.org/
25+
.. _tcpdump: https://www.tcpdump.org/
26+
.. _Net-SNMP: http://www.net-snmp.org/

Diff for: ‎docs/source/index.rst

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1+
.. include:: /includes/_links.rst
12

2-
.. _snmplabs.com:
3+
.. _pysnmp.com:
34

45
Welcome to PySNMP Documentation
56
===============================
67

78
.. toctree::
89
:maxdepth: 2
910

10-
Welcome to the official documentation for PySNMP, a comprehensive SNMP ecosystem for `Python <https://www.python.org>`_ that has been empowering developers and network administrators to build SNMP-based applications for over two decades. PySNMP offers a rich set of libraries/tools enabling SNMPv3 and IPv6 support, MIB file handling, and asynchronous operations, all implemented in pure Python.
11+
Welcome to the official documentation for PySNMP, a comprehensive SNMP
12+
ecosystem for `Python`_ that has been empowering developers and network
13+
administrators to build SNMP-based applications for over two decades. PySNMP
14+
offers a rich set of libraries/tools enabling SNMPv3 and IPv6 support, MIB file
15+
handling, and asynchronous operations, all implemented in pure Python.
1116

1217
Key Features
1318
------------
@@ -43,7 +48,7 @@ Core Library
4348
------------
4449

4550
The core PySNMP library implements the SNMP engine in Python. Its source code
46-
is hosted at GitHub `https://github.com/lextudio/pysnmp/ <https://github.com/lextudio/pysnmp/>`_.
51+
is hosted at GitHub `https://github.com/lextudio/pysnmp <https://github.com/lextudio/pysnmp>`_.
4752

4853
.. toctree::
4954
:maxdepth: 2
@@ -75,14 +80,15 @@ Additional Resources
7580

7681
/history
7782
/snmp-simulation-service
83+
/support
84+
/license
7885

7986
Contributing
8087
------------
8188

82-
PySNMP is an open-source project, and contributions are welcome. Visit our `GitHub repository <https://github.com/lextudio/pysnmp/>`_ to fork, submit PRs, or report issues.
83-
84-
License
85-
-------
89+
PySNMP is an open-source project, and contributions are welcome. Visit our
90+
`PySNMP GitHub repository`_ to fork, submit PRs, or report issues.
8691

8792
PySNMP is freely available under terms that allow for both personal and
88-
commercial use. Learn more about the PySNMP license in the :doc:`/license`.
93+
commercial use. Learn more about the PySNMP license in the :doc:`/license`
94+
section.

Diff for: ‎docs/source/license.rst

+7
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,10 @@ License
44
=======
55

66
.. include:: ../../LICENSE.rst
7+
8+
References
9+
----------
10+
11+
- :doc:`/support`
12+
- `PySNMP Quick Start <https://www.pysnmp.com/pysnmp/quick-start>`_
13+
- :doc:`/history`

Diff for: ‎docs/source/snmp-simulation-service.rst

+8
Original file line numberDiff line numberDiff line change
@@ -596,3 +596,11 @@ securityEngineId should not be used:
596596
-x des -X privkey1 \
597597
demo.pysnmp.com 12345 \
598598
1.3.6.1.4.1.20408.4.1.1.2 1.3.6.1.2.1.1.1.0 s hello
599+
600+
References
601+
----------
602+
603+
- :doc:`/support`
604+
- `PySNMP Quick Start <https://www.pysnmp.com/pysnmp/quick-start>`_
605+
- :doc:`/license`
606+
- :doc:`/history`

Diff for: ‎docs/source/support.rst

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
.. include:: /includes/_links.rst
2+
3+
.. _support:
4+
5+
Support Options
6+
===============
7+
8+
The PySNMP ecosystem is a robust and dynamic environment that offers a variety
9+
of support channels to cater to the diverse needs of its users. Whether you're
10+
a beginner just starting out with PySNMP, an experienced developer looking for
11+
advanced guidance, or an organization requiring dedicated assistance, there's a
12+
support option available for you.
13+
14+
Community Support
15+
-----------------
16+
17+
Community support is a great way to seek help and learn from the collective
18+
wisdom of the PySNMP community. This support is primarily available through
19+
Stack Overflow and GitHub.
20+
21+
Stack Overflow
22+
++++++++++++++
23+
24+
`Stack Overflow`_ is a popular platform for programmers to learn, share their
25+
knowledge, and build their careers.
26+
27+
When you post your questions on Stack Overflow under the PySNMP tag, you're not
28+
just asking a single person for help. You're reaching out to a vast network of
29+
experienced users and developers who are active on the platform and are willing
30+
to assist you. This is a great way to get diverse perspectives and solutions to
31+
your problems.
32+
33+
Moreover, Stack Overflow has a comprehensive archive of previously asked
34+
questions and answers. It's highly likely that someone else has already faced
35+
the same issue as you and has received an answer. This makes Stack Overflow not
36+
just a platform for asking questions, but also a valuable resource for learning
37+
and problem-solving.
38+
39+
GitHub
40+
++++++
41+
42+
PySNMP has an active GitHub repository, which is another major channel for
43+
support. GitHub is a web-based hosting service for version control and
44+
collaboration. It allows you to work on projects from anywhere and collaborate
45+
with others.
46+
47+
On `PySNMP GitHub repository`_, you can report issues, suggest enhancements,
48+
and contribute to the project. The developers and maintainers of PySNMP closely
49+
monitor the repository and provide support. They are actively involved in
50+
addressing the issues reported by users, considering the enhancement
51+
suggestions, and merging the contributions made by users.
52+
53+
Contributing to the GitHub repository is also a great way to learn and grow as
54+
a developer. By reporting issues and suggesting enhancements, you're helping to
55+
improve PySNMP for everyone. By contributing to the project, you're not just
56+
solving your own problems, but also helping others who might face the same
57+
issues in the future.
58+
59+
Commercial Support
60+
------------------
61+
62+
For organizations that require dedicated assistance and priority support,
63+
`LeXtudio Inc.`_, the current maintainer of PySNMP, offers commercial support
64+
contracts. These contracts provide direct access to the current core PySNMP
65+
contributors and ensure timely resolution of issues.
66+
67+
Commercial support is a premium service that caters to the specific needs of
68+
organizations. It's designed to provide a higher level of technical support
69+
service than community support or GitHub. With commercial support, you get
70+
priority access to the development team, which means your issues are addressed
71+
first. This can be crucial for organizations where time is of the essence and
72+
issues need to be resolved quickly.
73+
74+
Moreover, with commercial support, you get dedicated assistance. This means you
75+
have a team of experts at your disposal who are committed to helping you
76+
resolve your issues. They understand your needs and preferences and provide
77+
personalized support to ensure your satisfaction.
78+
79+
In conclusion, the PySNMP ecosystem offers a variety of support options to
80+
cater to the diverse needs of its users. Whether you prefer to seek help from
81+
the community, collaborate on GitHub, or require dedicated commercial support,
82+
there's a support option that suits your needs. The key is to choose the
83+
support option that best aligns with your needs and preferences, and make the
84+
most of the resources and assistance available to you.
85+
86+
References
87+
----------
88+
89+
- :doc:`/history`
90+
- `PySNMP Quick Start <https://www.pysnmp.com/pysnmp/quick-start>`_
91+
- :doc:`/license`

0 commit comments

Comments
 (0)