Skip to content

Commit

Permalink
Clean up Doc links (nautobot#299)
Browse files Browse the repository at this point in the history
  • Loading branch information
itdependsnetworks committed Jul 29, 2022
1 parent 1f40c99 commit 249fd59
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Nautobot Golden Configuration
# Nautobot Golden Config

<p align="center">
<img src="docs/images/icon-NautobotGoldenConfig.png" height="200px">
Expand All @@ -12,7 +12,7 @@

## Overview

The golden configuration plugin is a Nautobot plugin that aims to solve common configuration management challenges.
The Golden Config plugin is a Nautobot plugin that provides a NetDevOps approach to golden configuration and configuration compliance.

### Key Use Cases

Expand All @@ -34,18 +34,18 @@ There are many features and capabilities the plugin provides into the Nautobot e

The golden configuration is driven by jobs that run a series of tasks and the result is captured in this overview.

![Overview](./docs/images/ss_golden-overview.png)
![Overview](https://raw.githubusercontent.com/nautobot/nautobot-plugin-golden-config/develop/docs/images/ss_golden-overview.png)

The compliance report provides a high-level overview on the compliance of your network.
![Compliance Report](./docs/images/ss_compliance-report.png)
![Compliance Report](https://raw.githubusercontent.com/nautobot/nautobot-plugin-golden-config/develop/docs/images/ss_compliance-report.png)

The compliance overview will provide a per device and feature overview on the compliance of your network devices.
![Compliance Overview](./docs/images/ss_compliance-overview.png)
![Compliance Overview](https://raw.githubusercontent.com/nautobot/nautobot-plugin-golden-config/develop/docs/images/ss_compliance-overview.png)

Drilling into a specific device and feature, you can get an immediate detailed understanding of your device.
![Compliance Device](./docs/images/ss_compliance-device.png)
![Compliance Device](https://raw.githubusercontent.com/nautobot/nautobot-plugin-golden-config/develop/docs/images/ss_compliance-device.png)

![Compliance Rule](./docs/images/ss_compliance-rule.png)
![Compliance Rule](https://raw.githubusercontent.com/nautobot/nautobot-plugin-golden-config/develop/docs/images/ss_compliance-rule.png)

## Try it out!

Expand All @@ -57,11 +57,11 @@ This App is installed in the Nautobot Community Sandbox found over at [demo.naut

Full web-based HTML documentation for this app can be found over on the [Nautobot Docs](https://github.com/nautobot/nautobot-plugin-golden-config) website:

- [User Guide](https://github.com/nautobot/nautobot-plugin-golden-config/user/) - Overview, Using the App, Getting Started, Navigating compliance (cli, json, custom), backup, app usage, intended state creation.
- [Administrator Guide](https://github.com/nautobot/nautobot-plugin-golden-config/admin/) - How to Install, Configure, Upgrade, or Uninstall the App.
- [Developer Guide](https://github.com/nautobot/nautobot-plugin-golden-config/dev/) - Extending the App, API Reference, Contribution Guide.
- [Release Notes / Changelog](https://github.com/nautobot/nautobot-plugin-golden-config/admin/release_notes)
- [Frequently Asked Questions](https://github.com/nautobot/nautobot-plugin-golden-config/user/app_faq)
- [User Guide](./docs/user/) - Overview, Using the App, Getting Started, Navigating compliance (cli, json, custom), backup, app usage, intended state creation.
- [Administrator Guide](./docs/admin/) - How to Install, Configure, Upgrade, or Uninstall the App.
- [Developer Guide](./docs/dev/) - Extending the App, API Reference, Contribution Guide.
- [Release Notes / Changelog](./docs/admin/release_notes)
- [Frequently Asked Questions](./docs/user/app_faq)

### Contributing to the Docs

Expand All @@ -71,4 +71,4 @@ Project documentation is generated by [mkdocs](https://www.mkdocs.org/) from the

## Questions

For any questions or comments, please check the [FAQ](docs/user/app_faq.md) first. Feel free to also swing by the [Network to Code slack channel](https://networktocode.slack.com/) (channel #networktocode), sign up [here](http://slack.networktocode.com/).
For any questions or comments, please check the [FAQ](./docs/user/app_faq.md) first. Feel free to also swing by the [Network to Code slack channel](https://networktocode.slack.com/) (channel #nautobot), sign up [here](http://slack.networktocode.com/).
2 changes: 1 addition & 1 deletion docs/admin/release_notes/version_0.9.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# v1.1 Release Notes
# v0.9 Release Notes

- Initial release

Expand Down

0 comments on commit 249fd59

Please sign in to comment.