diff --git a/docs/configuration/development.md b/docs/configuration/development.md index 1579f2cdb..6e1a4d9c4 100644 --- a/docs/configuration/development.md +++ b/docs/configuration/development.md @@ -5,7 +5,7 @@ Default: False This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only -clients which access NetBox from a recognized [internal IP address](#internal_ips) will see debugging tools in the user +clients which access NetBox from a recognized [internal IP address](./system.md#internal_ips) will see debugging tools in the user interface. !!! warning diff --git a/docs/configuration/system.md b/docs/configuration/system.md index f3c68db1b..b3b43c1f6 100644 --- a/docs/configuration/system.md +++ b/docs/configuration/system.md @@ -83,7 +83,7 @@ Default: `('127.0.0.1', '::1')` A list of IP addresses recognized as internal to the system, used to control the display of debugging output. For example, the debugging toolbar will be viewable only when a client is accessing NetBox from one of the listed IP -addresses (and [`DEBUG`](#debug) is true). +addresses (and [`DEBUG`](./development.md#debug) is true). --- @@ -106,7 +106,7 @@ JINJA2_FILTERS = { ## LOGGING -By default, all messages of INFO severity or higher will be logged to the console. Additionally, if [`DEBUG`](#debug) is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in [`ADMINS`](#admins). +By default, all messages of INFO severity or higher will be logged to the console. Additionally, if [`DEBUG`](./development.md#debug) is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in [`ADMINS`](./miscellaneous.md#admins). The Django framework on which NetBox runs allows for the customization of logging format and destination. Please consult the [Django logging documentation](https://docs.djangoproject.com/en/stable/topics/logging/) for more information on configuring this setting. Below is an example which will write all INFO and higher messages to a local file: diff --git a/docs/development/release-checklist.md b/docs/development/release-checklist.md index f86dac6a5..37d22e009 100644 --- a/docs/development/release-checklist.md +++ b/docs/development/release-checklist.md @@ -19,7 +19,7 @@ Sometimes it becomes necessary to constrain dependencies to a particular version djangorestframework==3.8.1 ``` -These version constraints are added to `base_requirements.txt` to ensure that newer packages are not installed when updating the pinned dependencies in `requirements.txt` (see the [Update Requirements](#update-requirements) section below). Before each new minor version of NetBox is released, all such constraints on dependent packages should be addressed if feasible. This guards against the collection of stale constraints over time. +These version constraints are added to `base_requirements.txt` to ensure that newer packages are not installed when updating the pinned dependencies in `requirements.txt` (see the [Update Requirements](#update-python-dependencies) section below). Before each new minor version of NetBox is released, all such constraints on dependent packages should be addressed if feasible. This guards against the collection of stale constraints over time. ### Close the Release Milestone diff --git a/docs/development/style-guide.md b/docs/development/style-guide.md index 283ad698c..9e5606749 100644 --- a/docs/development/style-guide.md +++ b/docs/development/style-guide.md @@ -41,7 +41,7 @@ Line breaks are permitted following binary operators. ### Enforcing Code Style -The [`pycodestyle`](https://pypi.org/project/pycodestyle/) utility (formerly `pep8`) is used by the CI process to enforce code style. A [pre-commit hook](./getting-started.md#2-enable-pre-commit-hooks) which runs this automatically is included with NetBox. To invoke `pycodestyle` manually, run: +The [`pycodestyle`](https://pypi.org/project/pycodestyle/) utility (formerly `pep8`) is used by the CI process to enforce code style. A [pre-commit hook](./getting-started.md#3-enable-pre-commit-hooks) which runs this automatically is included with NetBox. To invoke `pycodestyle` manually, run: ``` pycodestyle --ignore=W504,E501 netbox/