Skip to content

Commit

Permalink
Update install.md (#857)
Browse files Browse the repository at this point in the history
* Update install.md
  • Loading branch information
itdependsnetworks authored Jan 3, 2025
1 parent bda93e1 commit 4bb4b9f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
1 change: 1 addition & 0 deletions changes/857.added
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fixed installation docs to make clear that configurations are sample configurations.
3 changes: 2 additions & 1 deletion docs/admin/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@ echo nautobot-golden-config >> local_requirements.txt
Once installed, the app needs to be enabled in your Nautobot configuration. The following block of code below shows the additional configuration required to be added to your `nautobot_config.py` file:

- Append `"nautobot_golden_config"` to the `PLUGINS` list, and `"nautobot_plugin_nornir"` if it was not already there (more info [here](https://docs.nautobot.com/projects/plugin-nornir/en/latest/)).
- Append the `"nautobot_golden_config"` dictionary to the `PLUGINS_CONFIG` dictionary, and `"nautobot_plugin_nornir"` if it was not already there.
- Append the `"nautobot_golden_config"` dictionary to the `PLUGINS_CONFIG` dictionary as shown the **sample** below with your appropriate configs.
- Append the `"nautobot_plugin_nornir"` dictionary to the `PLUGINS_CONFIG` dictionary as shown the **sample** below with your appropriate configs (Note: this may already be in your configs).

```python
PLUGINS = ["nautobot_plugin_nornir", "nautobot_golden_config"]
Expand Down

0 comments on commit 4bb4b9f

Please sign in to comment.