diff --git a/changes/857.added b/changes/857.added new file mode 100644 index 00000000..c336578f --- /dev/null +++ b/changes/857.added @@ -0,0 +1 @@ +Fixed installation docs to make clear that configurations are sample configurations. \ No newline at end of file diff --git a/docs/admin/install.md b/docs/admin/install.md index 49e4fdee..6ccb9ebe 100644 --- a/docs/admin/install.md +++ b/docs/admin/install.md @@ -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"]