From 9ad05c430b127c8c511a84af192f86573f3a43dd Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 14 Apr 2025 09:13:45 -0400 Subject: [PATCH] Docs cleanup --- docs/configuration/system.md | 4 ++++ docs/models/dcim/devicerole.md | 2 ++ docs/models/dcim/racktype.md | 2 ++ docs/plugins/development/models.md | 5 ++--- docs/release-notes/version-4.3.md | 2 +- mkdocs.yml | 1 + 6 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/configuration/system.md b/docs/configuration/system.md index 11db09370..63e7cf64f 100644 --- a/docs/configuration/system.md +++ b/docs/configuration/system.md @@ -14,6 +14,8 @@ BASE_PATH = 'netbox/' ## DATABASE_ROUTERS +!!! info "This parameter was introduced in NetBox v4.3." + Default: `[]` (empty list) An iterable of [database routers](https://docs.djangoproject.com/en/stable/topics/db/multi-db/) to use for automatically selecting the appropriate database(s) for a query. This is useful only when [multiple databases](./required-parameters.md#databases) have been configured. @@ -172,6 +174,8 @@ The file path to the location where media files (such as image attachments) are ## PROXY_ROUTERS +!!! info "This parameter was introduced in NetBox v4.3." + Default: `["utilities.proxy.DefaultProxyRouter"]` A list of Python classes responsible for determining which proxy server(s) to use for outbound HTTP requests. Each item in the list can be the class itself or the dotted path to the class. diff --git a/docs/models/dcim/devicerole.md b/docs/models/dcim/devicerole.md index e58373565..abff149d6 100644 --- a/docs/models/dcim/devicerole.md +++ b/docs/models/dcim/devicerole.md @@ -6,6 +6,8 @@ Devices can be organized by functional roles, which are fully customizable by th ### Parent +!!! info "This field was introduced in NetBox v4.3." + The parent role of which this role is a child (optional). ### Name diff --git a/docs/models/dcim/racktype.md b/docs/models/dcim/racktype.md index ecaf539c9..5298e8b26 100644 --- a/docs/models/dcim/racktype.md +++ b/docs/models/dcim/racktype.md @@ -42,6 +42,8 @@ The number of the numerically lowest unit in the rack. This value defaults to on The external width, height and depth of the rack can be tracked to aid in floorplan calculations. These measurements must be designated in either millimeters or inches. +!!! info "The `outer_height` field was introduced in NetBox v4.3." + ### Mounting Depth The maximum depth of a mounted device that the rack can accommodate, in millimeters. For four-post frames or cabinets, this is the horizontal distance between the front and rear vertical rails. (Note that this measurement does _not_ include space between the rails and the cabinet doors.) diff --git a/docs/plugins/development/models.md b/docs/plugins/development/models.md index 492b7fc97..508c4ce89 100644 --- a/docs/plugins/development/models.md +++ b/docs/plugins/development/models.md @@ -119,6 +119,8 @@ For more information about database migrations, see the [Django documentation](h ::: netbox.models.features.ContactsMixin +!!! info "Plugin support for ContactsMixin was introduced in NetBox v4.3." + ::: netbox.models.features.CustomLinksMixin ::: netbox.models.features.CustomFieldsMixin @@ -127,9 +129,6 @@ For more information about database migrations, see the [Django documentation](h ::: netbox.models.features.EventRulesMixin -!!! note - `EventRulesMixin` was renamed from `WebhooksMixin` in NetBox v3.7. - ::: netbox.models.features.ExportTemplatesMixin ::: netbox.models.features.JobsMixin diff --git a/docs/release-notes/version-4.3.md b/docs/release-notes/version-4.3.md index 0ca4ecfdf..a5e90eb5e 100644 --- a/docs/release-notes/version-4.3.md +++ b/docs/release-notes/version-4.3.md @@ -6,7 +6,7 @@ * PostgreSQL 13 is no longer supported. NetBox v4.3 requires PostgreSQL 14.0 or later. * The `ALLOW_TOKEN_RETRIEVAL` configuration parameter now defaults to False. * The `device` and `virtual_machine` foreign keys on the Service model have been replaced with a generic `parent` relationship to support the assignment of services to FHRP groups as well. -* The `group` foreign key on the Contact model has been replaced with a many-to-many `groups` field. +* The `group` foreign key on the Contact model has been replaced with a many-to-many `groups` field. * PluginTemplateExtension no longer supports registration via the singular `model` attribute (use `models` instead). * The legacy staged changes functionality has been removed. diff --git a/mkdocs.yml b/mkdocs.yml index 224ee4c67..1b4e6c393 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -202,6 +202,7 @@ nav: - ModuleBay: 'models/dcim/modulebay.md' - ModuleBayTemplate: 'models/dcim/modulebaytemplate.md' - ModuleType: 'models/dcim/moduletype.md' + - ModuleTypeProfile: 'models/dcim/moduletypeprofile.md' - Platform: 'models/dcim/platform.md' - PowerFeed: 'models/dcim/powerfeed.md' - PowerOutlet: 'models/dcim/poweroutlet.md'