From 53a1c4a015237fd6cd182c57d7d0a0deaacc8522 Mon Sep 17 00:00:00 2001 From: Mircea Ulinic Date: Thu, 3 Oct 2019 15:17:14 +0100 Subject: [PATCH] Correct documentation relative links Was looking at the documentation for enabling webhooks ([this](https://netbox.readthedocs.io/en/stable/configuration/optional-settings/#webhooks_enabled) paragraph), and the link points to a non-existing page (https://netbox.readthedocs.io/en/stable/configuration/additional-features/webhooks/). This is due to an incorrect relative link. Similarly for the prometheus configuration. Adding also git ignore for the site/ dir, generated by mkdoc, when building the documentation locally. --- .gitignore | 1 + docs/configuration/optional-settings.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 36c6d3fa8..91c7f0d36 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ /netbox/scripts/* !/netbox/scripts/__init__.py /netbox/static +site/* .idea /*.sh !upgrade.sh diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index b532c9757..9397339a7 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -207,7 +207,7 @@ The file path to the location where media files (such as image attachments) are Default: False -Toggle exposing Prometheus metrics at `/metrics`. See the [Prometheus Metrics](../additional-features/prometheus-metrics/) documentation for more details. +Toggle exposing Prometheus metrics at `/metrics`. See the [Prometheus Metrics](../additional-features/prometheus-metrics.md) documentation for more details. --- @@ -305,7 +305,7 @@ The time zone NetBox will use when dealing with dates and times. It is recommend Default: False -Enable this option to run the webhook backend. See the docs section on the webhook backend [here](../additional-features/webhooks/) for more information on setup and use. +Enable this option to run the webhook backend. See the docs section on the webhook backend [here](../additional-features/webhooks.md) for more information on setup and use. ---