diff --git a/docs/additional-features/webhooks.md b/docs/additional-features/webhooks.md index f3dd80337..e3b352125 100644 --- a/docs/additional-features/webhooks.md +++ b/docs/additional-features/webhooks.md @@ -1,6 +1,6 @@ # Webhooks -A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are configured in the admin UI under Extras > Webhooks. +A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are managed under Logging > Webhooks. ## Configuration diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 2a3d267ba..9653968fe 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -98,7 +98,7 @@ CORS_ORIGIN_WHITELIST = [ ## CUSTOM_VALIDATORS -This is a mapping of models to [custom validators](../additional-features/custom-validation.md) that have been defined locally to enforce custom validation logic. +This is a mapping of models to [custom validators](../customization/custom-validation.md) that have been defined locally to enforce custom validation logic. --- @@ -501,7 +501,7 @@ This parameter defines the URL of the repository that will be checked periodical Default: `$INSTALL_ROOT/netbox/reports/` -The file path to the location where custom reports will be kept. By default, this is the `netbox/reports/` directory within the base NetBox installation path. +The file path to the location where [custom reports](../customization/reports.md) will be kept. By default, this is the `netbox/reports/` directory within the base NetBox installation path. --- @@ -517,7 +517,7 @@ The maximum execution time of a background task (such as running a custom script Default: `$INSTALL_ROOT/netbox/scripts/` -The file path to the location where custom scripts will be kept. By default, this is the `netbox/scripts/` directory within the base NetBox installation path. +The file path to the location where [custom scripts](../customization/custom-scripts.md) will be kept. By default, this is the `netbox/scripts/` directory within the base NetBox installation path. --- diff --git a/docs/additional-features/custom-fields.md b/docs/customization/custom-fields.md similarity index 97% rename from docs/additional-features/custom-fields.md rename to docs/customization/custom-fields.md index 649f69256..a9acfb3f7 100644 --- a/docs/additional-features/custom-fields.md +++ b/docs/customization/custom-fields.md @@ -8,7 +8,7 @@ Within the database, custom fields are stored as JSON data directly alongside ea ## Creating Custom Fields -Custom fields must be created through the admin UI under Extras > Custom Fields. NetBox supports six types of custom field: +Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports six types of custom field: * Text: Free-form text (up to 255 characters) * Integer: A whole number (positive or negative) diff --git a/docs/additional-features/custom-links.md b/docs/customization/custom-links.md similarity index 75% rename from docs/additional-features/custom-links.md rename to docs/customization/custom-links.md index 0a00b6d68..dc8f28b71 100644 --- a/docs/additional-features/custom-links.md +++ b/docs/customization/custom-links.md @@ -1,8 +1,8 @@ # Custom Links -Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related records in systems outside of NetBox. For example, you might create a custom link on the device view which links to the current device in a network monitoring system. +Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related records in systems outside NetBox. For example, you might create a custom link on the device view which links to the current device in a network monitoring system. -Custom links are created under the admin UI. Each link is associated with a particular NetBox object type (site, device, prefix, etc.) and will be displayed on relevant views. Each link is assigned text and a URL, both of which support Jinja2 templating. The text and URL are rendered with the context variable `obj` representing the current object. +Custom links are created by navigating to Customization > Custom Links. Each link is associated with a particular NetBox object type (site, device, prefix, etc.) and will be displayed on relevant views. Each link is assigned text and a URL, both of which support Jinja2 templating. The text and URL are rendered with the context variable `obj` representing the current object. For example, you might define a link like this: @@ -15,7 +15,7 @@ When viewing a device named Router4, this link would render as: View NMS ``` -Custom links appear as buttons at the top right corner of the page. Numeric weighting can be used to influence the ordering of links. +Custom links appear as buttons in the top right corner of the page. Numeric weighting can be used to influence the ordering of links. ## Context Data diff --git a/docs/additional-features/custom-scripts.md b/docs/customization/custom-scripts.md similarity index 100% rename from docs/additional-features/custom-scripts.md rename to docs/customization/custom-scripts.md diff --git a/docs/additional-features/custom-validation.md b/docs/customization/custom-validation.md similarity index 100% rename from docs/additional-features/custom-validation.md rename to docs/customization/custom-validation.md diff --git a/docs/additional-features/export-templates.md b/docs/customization/export-templates.md similarity index 98% rename from docs/additional-features/export-templates.md rename to docs/customization/export-templates.md index c80d5b8a1..0d0f7169e 100644 --- a/docs/additional-features/export-templates.md +++ b/docs/customization/export-templates.md @@ -1,6 +1,6 @@ # Export Templates -NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Extras > Export Templates under the admin interface. +NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates. Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension. diff --git a/docs/additional-features/reports.md b/docs/customization/reports.md similarity index 100% rename from docs/additional-features/reports.md rename to docs/customization/reports.md diff --git a/docs/development/models.md b/docs/development/models.md index 29d17c29d..93a10fff6 100644 --- a/docs/development/models.md +++ b/docs/development/models.md @@ -10,8 +10,8 @@ The Django [content types](https://docs.djangoproject.com/en/stable/ref/contrib/ * [Change logging](../additional-features/change-logging.md) - Changes to these objects are automatically recorded in the change log * [Webhooks](../additional-features/webhooks.md) - NetBox is capable of generating outgoing webhooks for these objects -* [Custom fields](../additional-features/custom-fields.md) - These models support the addition of user-defined fields -* [Export templates](../additional-features/export-templates.md) - Users can create custom export templates for these models +* [Custom fields](../customization/custom-fields.md) - These models support the addition of user-defined fields +* [Export templates](../customization/export-templates.md) - Users can create custom export templates for these models * [Tagging](../models/extras/tag.md) - The models can be tagged with user-defined tags * [Journaling](../additional-features/journaling.md) - These models support persistent historical commentary * Nesting - These models can be nested recursively to create a hierarchy diff --git a/docs/release-notes/version-2.6.md b/docs/release-notes/version-2.6.md index e8228920d..7e9e8fea3 100644 --- a/docs/release-notes/version-2.6.md +++ b/docs/release-notes/version-2.6.md @@ -218,7 +218,7 @@ #### Custom Scripts ([#3415](https://github.com/netbox-community/netbox/issues/3415)) -Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perform other tasks within NetBox. Scripts are defined as Python files which contain one or more subclasses of `extras.scripts.Script`. Variable fields can be defined within scripts, which render as form fields within the web UI to prompt the user for input data. Scripts are executed and information is logged via the web UI. Please see [the docs](https://netbox.readthedocs.io/en/stable/additional-features/custom-scripts/) for more detail. +Custom scripts allow for the execution of arbitrary code via the NetBox UI. They can be used to automatically create, manipulate, or clean up objects or perform other tasks within NetBox. Scripts are defined as Python files which contain one or more subclasses of `extras.scripts.Script`. Variable fields can be defined within scripts, which render as form fields within the web UI to prompt the user for input data. Scripts are executed and information is logged via the web UI. Please see [the docs](https://netbox.readthedocs.io/en/stable/customization/custom-scripts/) for more detail. Note: There are currently no API endpoints for this feature. These are planned for the upcoming v2.7 release. diff --git a/docs/release-notes/version-3.0.md b/docs/release-notes/version-3.0.md index 7674d57a6..f408bae6b 100644 --- a/docs/release-notes/version-3.0.md +++ b/docs/release-notes/version-3.0.md @@ -46,7 +46,7 @@ CUSTOM_VALIDATORS = { } ``` -CustomValidator can also be subclassed to enforce more complex logic by overriding its `validate()` method. See the [custom validation](../additional-features/custom-validation.md) documentation for more details. +CustomValidator can also be subclassed to enforce more complex logic by overriding its `validate()` method. See the [custom validation](../customization/custom-validation.md) documentation for more details. ### Enhancements diff --git a/mkdocs.yml b/mkdocs.yml index 875d04d3e..89b72d433 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -59,19 +59,20 @@ nav: - Circuits: 'core-functionality/circuits.md' - Power Tracking: 'core-functionality/power.md' - Tenancy: 'core-functionality/tenancy.md' + - Customization: + - Custom Fields: 'customization/custom-fields.md' + - Custom Validation: 'customization/custom-validation.md' + - Custom Links: 'customization/custom-links.md' + - Export Templates: 'customization/export-templates.md' + - Custom Scripts: 'customization/custom-scripts.md' + - Reports: 'customization/reports.md' - Additional Features: - Caching: 'additional-features/caching.md' - Change Logging: 'additional-features/change-logging.md' - Context Data: 'models/extras/configcontext.md' - - Custom Fields: 'additional-features/custom-fields.md' - - Custom Validation: 'additional-features/custom-validation.md' - - Custom Links: 'additional-features/custom-links.md' - - Custom Scripts: 'additional-features/custom-scripts.md' - - Export Templates: 'additional-features/export-templates.md' - Journaling: 'additional-features/journaling.md' - NAPALM: 'additional-features/napalm.md' - Prometheus Metrics: 'additional-features/prometheus-metrics.md' - - Reports: 'additional-features/reports.md' - Tags: 'models/extras/tag.md' - Webhooks: 'additional-features/webhooks.md' - Plugins: