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: docs/README-develop-types-providers.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -22,19 +22,19 @@ This document is a guide for writing new Puppet resource types and providers for
22
22
23
23
There are multiple components involved when creating new resources. This document focuses on the type and provider files:
24
24
25
-

25
+

26
26
27
27
* Every resource is associated with a [resource type](https://docs.puppetlabs.com/puppet/latest/reference/lang_resources.html), which determines the kind of configuration it manages.
28
28
29
29
*[Resource providers](https://docs.puppetlabs.com/guides/provider_development.html) are essentially backends that implement support for a specific implementation of a given resource type.
30
30
31
-
* The types and providers work in conjunction with a node\_utils API, which is the interface between Puppet agent and the NX-OS CLI. Please see the [README-develop-node-utils-APIs.md] (https://github.com/cisco/cisco-network-node-utils/blob/master/README-develop-node-utils-APIs.md) guide for more information on writing node_utils APIs.
31
+
* The types and providers work in conjunction with a node\_utils API, which is the interface between Puppet agent and the NX-OS CLI. Please see the [README-develop-node-utils-APIs.md] (https://github.com/cisco/cisco-network-node-utils/blob/master/docs/README-develop-node-utils-APIs.md) guide for more information on writing node_utils APIs.
32
32
33
-
This document relies heavily on example code. The examples in this document can be written independently, but they are intended to work in conjuction with the example node_utils APIs created in the [README-develop-node_utils-APIs.md](https://github.com/cisco/cisco-network-node-utils/blob/master/README-develop-node-utils-APIs.md) guide. The examples in that guide are based on code templates for the `feature bash-shell` CLI and the `router eigrp` CLI. Note that some people prefer to write the node_utils API before the resource types and providers, while others might prefer the opposite workflow.
33
+
This document relies heavily on example code. The examples in this document can be written independently, but they are intended to work in conjuction with the example node_utils APIs created in the [README-develop-node_utils-APIs.md](https://github.com/cisco/cisco-network-node-utils/blob/master/docs/README-develop-node-utils-APIs.md) guide. The examples in that guide are based on code templates for the `feature bash-shell` CLI and the `router eigrp` CLI. Note that some people prefer to write the node_utils API before the resource types and providers, while others might prefer the opposite workflow.
34
34
35
35
## <aname="clone">Start here: Clone the Repo</a>
36
36
37
-
Please see the [CONTRIBUTING](#CONTRIBUTING) document for workflow instructions. In general, fork the ciscopuppet repository for your changes and submit a pull request when it is ready for commit.
37
+
Please see the [CONTRIBUTING](../CONTRIBUTING.md) document for workflow instructions. In general, fork the ciscopuppet repository for your changes and submit a pull request when it is ready for commit.
38
38
39
39
First install the code base. Clone the ciscopuppet repo into a workspace:
This resource type and provider exercise will build on the router_eigrp API example shown in the cisco node_utils [README-develop-node-utils-APIs](https://github.com/cisco/cisco-network-node-utils/blob/master/README-develop-node-utils-APIs.md) document.
299
+
This resource type and provider exercise will build on the router_eigrp API example shown in the cisco node_utils [README-develop-node-utils-APIs](https://github.com/cisco/cisco-network-node-utils/blob/master/docs/README-develop-node-utils-APIs.md) document.
300
300
The router_eigrp node_utils example created a new API for the cli below:
301
301
302
302
~~~
@@ -699,4 +699,4 @@ Inspecting 2 files
699
699
700
700
## <aname="next">Next Steps</a>
701
701
702
-
Please see the [CONTRIBUTING](#CONTRIBUTING) document for workflow instructions.
702
+
Please see the [CONTRIBUTING](../CONTRIBUTING.md) document for workflow instructions.
Copy file name to clipboardExpand all lines: docs/README-maintainers.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Maintainers Guide
2
2
3
-
Guidelines for the core maintainers of the ciscopuppet project - above and beyond the [general developer guidelines](https://github.com/cisco/cisco-network-puppet-module/blob/develop/CONTRIBUTING.md).
3
+
Guidelines for the core maintainers of the ciscopuppet project - above and beyond the [general developer guidelines](../CONTRIBUTING.md).
4
4
5
5
## Accepting Pull Requests
6
6
@@ -77,4 +77,4 @@ When we agree as a team that a new release should be published, the process is a
77
77
git push --tags
78
78
```
79
79
80
-
6. Add release notes on GitHub, for example `https://github.com/cisco/cisco-network-puppet-module/releases/new?tag=v1.0.1`. Usually this will just be a copy-and-paste of the relevant section of the `CHANGELOG.md`.
80
+
6. Add release notes on GitHub, for example `https://github.com/cisco/cisco-network-puppet-module/releases/new?tag=v1.0.1`. Usually this will just be a copy-and-paste of the relevant section of the `CHANGELOG.md`.
Copy file name to clipboardExpand all lines: examples/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ This document describes how to use the example demo manifest files contained wit
20
20
*`demo_bgp_[ipv4|ipv6]_site.pp`
21
21
* Provides sample manifests to configure bgp using the `cisco_command_config` provider.
22
22
23
-
**Note:** Before following the steps in this guide make sure the puppet agent is [installed and configured.](https://github.com/puppetlabs/cisco-ciscopuppet/blob/master/README-AGENT-INSTALL.md)
23
+
**Note:** Before following the steps in this guide make sure the puppet agent is [installed and configured.](../docs/README-AGENT-INSTALL.md)
0 commit comments