Skip to content

Commit 3268328

Browse files
committed
Merge branch 'hotfix/1.0.1'
2 parents 7de35ff + b5b05d7 commit 3268328

9 files changed

+26
-25
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
All notable changes to this project will be documented in this file.
33
This project adheres to [Semantic Versioning](http://semver.org/).
44

5+
## [1.0.1] - 2015-09-18
6+
### Fixed
7+
- Fixed broken documentation links
8+
59
## [1.0.0] - 2015-08-28
610
### Added
711
- New facts `cisco_node_utils` and `cisco_nxapi` report the installed version of these gems.

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Cisco Network Elements support a rich set of features to make networks robust, e
1010

1111
* Fork the repository
1212
* Pull a branch under the "develop" branch for your changes.
13-
* Follow all guidelines documented in [README-creating-types-providers](README-creating-types-providers.md)
13+
* Follow all guidelines documented in [README-develop-types-providers](docs/README-develop-types-providers.md)
1414
* Make changes in your branch.
1515
* Testing
1616
* Add beaker test cases to validate your changes.

docs/README-agent-install.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -243,10 +243,10 @@ This file can be used to override the default Puppet settings. At a minimum, the
243243

244244
See the following references for more puppet.conf settings:
245245

246-
<https://docs.puppetlabs.com/puppet/latest/reference/config_important_settings.html>
247-
<https://docs.puppetlabs.com/puppet/latest/reference/config_about_settings.html>
248-
<https://docs.puppetlabs.com/puppet/latest/reference/config_file_main.html>
249-
<https://docs.puppetlabs.com/references/latest/configuration.html>
246+
* https://docs.puppetlabs.com/puppet/latest/reference/config_important_settings.html
247+
* https://docs.puppetlabs.com/puppet/latest/reference/config_about_settings.html
248+
* https://docs.puppetlabs.com/puppet/latest/reference/config_file_main.html
249+
* https://docs.puppetlabs.com/references/latest/configuration.html
250250

251251
#### Run the Puppet Agent
252252

docs/README-beaker-agent-install.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
3. [Beaker Installer Configuration](#beaker-install-config)
88
4. [Automated Puppet Agent Install: bash-shell](#install-bs)
99
5. [Automated Puppet Agent Install: guestshell](#install-gs)
10-
6. [References](#references)
11-
7. [Limitations](#limitations)
12-
8. [License Information](#license-information)
10+
6. [Limitations](#limitations)
11+
7. [License Information](#license-information)
1312

1413
## <a name="overview">Overview</a>
1514

@@ -64,8 +63,8 @@ end
6463
The following commands should be run on your Beaker workstation.
6564

6665
~~~
67-
$ git clone https://github.com/puppetlabs/cisco-ciscopuppet.git
68-
$ cd cisco-ciscopuppet/utilities/installer
66+
$ git clone https://github.com/cisco/cisco-network-puppet-module.git
67+
$ cd cisco-network-puppet-module/utilities/installer/
6968
~~~
7069

7170
### Copy and modify the SAMPLE* configuration files.

docs/README-develop-types-providers.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ This document is a guide for writing new Puppet resource types and providers for
2222

2323
There are multiple components involved when creating new resources. This document focuses on the type and provider files:
2424

25-
![1](docs/tp_files.png)
25+
![1](tp_files.png)
2626

2727
* 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.
2828

2929
* [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.
3030

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.
3232

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.
3434

3535
## <a name="clone">Start here: Clone the Repo</a>
3636

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.
3838

3939
First install the code base. Clone the ciscopuppet repo into a workspace:
4040

@@ -296,7 +296,7 @@ Inspecting 2 files
296296

297297
## <a name="comp_example">Complex Example: router eigrp</a>
298298

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/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.
300300
The router_eigrp node_utils example created a new API for the cli below:
301301

302302
~~~
@@ -699,4 +699,4 @@ Inspecting 2 files
699699

700700
## <a name="next">Next Steps</a>
701701

702-
Please see the [CONTRIBUTING](#CONTRIBUTING) document for workflow instructions.
702+
Please see the [CONTRIBUTING](../CONTRIBUTING.md) document for workflow instructions.

docs/README-maintainers.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Maintainers Guide
22

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).
44

55
## Accepting Pull Requests
66

@@ -77,4 +77,4 @@ When we agree as a team that a new release should be published, the process is a
7777
git push --tags
7878
```
7979
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`.

docs/README-package-provider.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44

55
1. [Overview](#overview)
66
2. [Syntax](#syntax)
7-
3. [Examples](examples)
8-
9. [References](#references)
9-
10. [Limitations](#limitations)
10-
11. [Known Issues](#issues)
7+
3. [Examples](#examples)
8+
4. [References](#references)
119

1210
## <a name="overview">Overview</a>
1311

@@ -51,7 +49,7 @@ where:
5149
* `provider`: Optional. Set to 'nxapi' if installling a Cisco package.
5250

5351

54-
## <a name="Examples">Examples</a>
52+
## <a name="examples">Examples</a>
5553

5654
* **Cisco RPMs**
5755

examples/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This document describes how to use the example demo manifest files contained wit
2020
* `demo_bgp_[ipv4|ipv6]_site.pp`
2121
* Provides sample manifests to configure bgp using the `cisco_command_config` provider.
2222

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)
2424

2525
## <a name="setup">Initial Setup</a>
2626

metadata.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "puppetlabs-ciscopuppet",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"author": "cisco",
55
"summary": "Cisco Puppet providers and types for NX-OS devices",
66
"license": "Apache-2.0",

0 commit comments

Comments
 (0)