You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31Lines changed: 31 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,10 @@
1
1
# Netutils
2
2
3
3
<<<<<<< HEAD
4
+
<<<<<<< HEAD
5
+
=======
4
6
=======
7
+
>>>>>>> 9ebf36e (Cookie updated by NetworkToCode Cookie Drift Manager Tool)
5
8
<!--
6
9
Developer Note - Remove Me!
7
10
@@ -12,23 +15,31 @@ The logo of the project is a placeholder (docs/images/icon-netutils.png) - pleas
12
15
To avoid extra work and temporary links, make sure that publishing docs (or merging a PR) is done at the same time as setting up the docs site on RTD, then test everything.
13
16
-->
14
17
18
+
<<<<<<< HEAD
15
19
>>>>>>> 725e2d2 (Cookie updated by NetworkToCode Cookie Drift Manager Tool)
20
+
=======
21
+
>>>>>>> 9ebf36e (Cookie updated by NetworkToCode Cookie Drift Manager Tool)
A Python library that is a collection of functions that are used in the common network automation tasks. Tasks such as converting a BGP ASN to and from dotted format, normalizing an interface name, or "type 5" encrypting a password. The intention is to centralize these functions while keeping the library light.
34
45
@@ -67,6 +78,26 @@ You can find all the Markdown source for the App documentation under the [`docs`
67
78
If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://netutils/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
68
79
>>>>>>> 725e2d2 (Cookie updated by NetworkToCode Cookie Drift Manager Tool)
69
80
81
+
=======
82
+
> Developer Note: Add a long (2-3 paragraphs) description of what the library does, what problems it solves, etc.
83
+
84
+
## Documentation
85
+
86
+
Full documentation for this library can be found over on the [Netutils Docs](https://netutils.readthedocs.io/) website:
87
+
88
+
-[User Guide](https://netutils.readthedocs.io/user/app_overview/) - Overview, Using the Library, Getting Started.
89
+
-[Administrator Guide](https://netutils.readthedocs.io/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the Library.
90
+
-[Developer Guide](https://netutils.readthedocs.io/dev/contributing/) - Extending the Library, Code Reference, Contribution Guide.
You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/networktocode/netutils/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
97
+
98
+
If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://netutils/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
99
+
100
+
>>>>>>> 9ebf36e (Cookie updated by NetworkToCode Cookie Drift Manager Tool)
70
101
Any PRs with fixes or improvements are very welcome!
Copy file name to clipboardExpand all lines: docs/dev/contributing.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -109,11 +109,15 @@ The branching policy includes the following tenets:
109
109
- PRs intended to address bug fixes and security patches should be sourced from the develop branch.
110
110
- PRs intended to add new features that break backward compatibility should be discussed before a PR is created.
111
111
112
+
<<<<<<< HEAD
112
113
<<<<<<< HEAD
113
114
Netutils will observe semantic versioning, as of 1.0. This may result in an quick turn around in minor versions to keep pace with an ever growing feature set.
114
115
=======
115
116
Netutils will observe Semantic Versioning, as of 1.0. This may result in an quick turn around in minor versions to keep pace with an ever growing feature set.
116
117
>>>>>>> 725e2d2 (Cookie updated by NetworkToCode Cookie Drift Manager Tool)
118
+
=======
119
+
Netutils will observe Semantic Versioning, as of 1.0. This may result in an quick turn around in minor versions to keep pace with an ever growing feature set.
120
+
>>>>>>> 9ebf36e (Cookie updated by NetworkToCode Cookie Drift Manager Tool)
0 commit comments