-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Fixes #19255: Improved documentation consistency for configuration default values #19258
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
5202b09
15db711
d8fd785
001e27d
f882afe
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
|
|
||
| ## PLUGINS | ||
|
|
||
| Default: Empty | ||
| Default: `Empty` | ||
|
|
||
| A list of installed [NetBox plugins](../plugins/index.md) to enable. Plugins will not take effect unless they are listed here. | ||
|
|
||
|
|
@@ -13,7 +13,7 @@ A list of installed [NetBox plugins](../plugins/index.md) to enable. Plugins wil | |
|
|
||
| ## PLUGINS_CONFIG | ||
|
|
||
| Default: Empty | ||
| Default: `Empty` | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Similar to
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jeremystretch thanks. Will switch it to [] |
||
|
|
||
| This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. An example configuration is shown below: | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -64,7 +64,7 @@ Email is sent from NetBox only for critical events or if configured for [logging | |||||
|
|
||||||
| ## HTTP_PROXIES | ||||||
|
|
||||||
| Default: None | ||||||
| Default: `None` | ||||||
|
|
||||||
| A dictionary of HTTP proxies to use for outbound requests originating from NetBox (e.g. when sending webhook requests). Proxies should be specified by schema (HTTP and HTTPS) as per the [Python requests library documentation](https://requests.readthedocs.io/en/latest/user/advanced/#proxies). For example: | ||||||
|
|
||||||
|
|
@@ -89,7 +89,7 @@ addresses (and [`DEBUG`](./development.md#debug) is true). | |||||
|
|
||||||
| ## ISOLATED_DEPLOYMENT | ||||||
|
|
||||||
| Default: False | ||||||
| Default: `False` | ||||||
|
|
||||||
| Set this configuration parameter to True for NetBox deployments which do not have Internet access. This will disable miscellaneous functionality which depends on access to the Internet. | ||||||
|
|
||||||
|
|
@@ -206,14 +206,14 @@ If `STORAGE_BACKEND` is not defined, this setting will be ignored. | |||||
|
|
||||||
| ## TIME_ZONE | ||||||
|
|
||||||
| Default: UTC | ||||||
| Default: `UTC` | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It might help to represent this explicitly as a string to avoid confusion with a global constant.
Suggested change
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jeremystretch thanks. Change made |
||||||
|
|
||||||
| The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. Please see the [list of available time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## TRANSLATION_ENABLED | ||||||
|
|
||||||
| Default: True | ||||||
| Default: `True` | ||||||
|
|
||||||
| Enables language translation for the user interface. (This parameter maps to Django's [USE_I18N](https://docs.djangoproject.com/en/stable/ref/settings/#std-setting-USE_I18N) setting.) | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Empty" isn't a literal value. We should either leave this as is, or change it to "
[](empty)"There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jeremystretch thanks. Will switch it to []