Просмотр исходного кода

Fix missing/incorrect documentation links

Jeremy Stretch 1 год назад
Родитель
Сommit
3ee951b0d0
3 измененных файлов с 29 добавлено и 25 удалено
  1. 2 2
      docs/models/virtualization/vminterface.md
  2. 23 23
      docs/plugins/development/index.md
  3. 4 0
      mkdocs.yml

+ 2 - 2
docs/models/virtualization/vminterface.md

@@ -29,10 +29,10 @@ If not selected, this interface will be treated as disabled/inoperative.
 
 ### Primary MAC Address
 
-The [MAC address](./macaddress.md) assigned to this interface which is designated as its primary.
+The [MAC address](../dcim/macaddress.md) assigned to this interface which is designated as its primary.
 
 !!! note "Changed in NetBox v4.2"
-    The MAC address of an interface (formerly a concrete database field) is available as a property, `mac_address`, which reflects the value of the primary linked [MAC address](./macaddress.md) object.
+    The MAC address of an interface (formerly a concrete database field) is available as a property, `mac_address`, which reflects the value of the primary linked [MAC address](../dcim/macaddress.md) object.
 
 ### MTU
 

+ 23 - 23
docs/plugins/development/index.md

@@ -98,29 +98,29 @@ NetBox looks for the `config` variable within a plugin's `__init__.py` to load i
 
 ### PluginConfig Attributes
 
-| Name                  | Description                                                                                                              |
-|-----------------------|--------------------------------------------------------------------------------------------------------------------------|
-| `name`                | Raw plugin name; same as the plugin's source directory                                                                   |
-| `verbose_name`        | Human-friendly name for the plugin                                                                                       |
-| `version`             | Current release ([semantic versioning](https://semver.org/) is encouraged)                                               |
-| `description`         | Brief description of the plugin's purpose                                                                                |
-| `author`              | Name of plugin's author                                                                                                  |
-| `author_email`        | Author's public email address                                                                                            |
-| `base_url`            | Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used.                        |
-| `required_settings`   | A list of any configuration parameters that **must** be defined by the user                                              |
-| `default_settings`    | A dictionary of configuration parameters and their default values                                                        |
-| `django_apps`         | A list of additional Django apps to load alongside the plugin                                                            |
-| `min_version`         | Minimum version of NetBox with which the plugin is compatible                                                            |
-| `max_version`         | Maximum version of NetBox with which the plugin is compatible                                                            |
-| `middleware`          | A list of middleware classes to append after NetBox's build-in middleware                                                |
-| `queues`              | A list of custom background task queues to create                                                                        |
-| `events_pipeline`     | A list of handlers to add to [`EVENTS_PIPELINE`](./miscellaneous.md#events_pipeline), identified by dotted paths         |
-| `search_extensions`   | The dotted path to the list of search index classes (default: `search.indexes`)                                          |
-| `data_backends`       | The dotted path to the list of data source backend classes (default: `data_backends.backends`)                           |
-| `template_extensions` | The dotted path to the list of template extension classes (default: `template_content.template_extensions`)              |
-| `menu_items`          | The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`)                      |
-| `graphql_schema`      | The dotted path to the plugin's GraphQL schema class, if any (default: `graphql.schema`)                                 |
-| `user_preferences`    | The dotted path to the dictionary mapping of user preferences defined by the plugin (default: `preferences.preferences`) |
+| Name                  | Description                                                                                                                        |
+|-----------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| `name`                | Raw plugin name; same as the plugin's source directory                                                                             |
+| `verbose_name`        | Human-friendly name for the plugin                                                                                                 |
+| `version`             | Current release ([semantic versioning](https://semver.org/) is encouraged)                                                         |
+| `description`         | Brief description of the plugin's purpose                                                                                          |
+| `author`              | Name of plugin's author                                                                                                            |
+| `author_email`        | Author's public email address                                                                                                      |
+| `base_url`            | Base path to use for plugin URLs (optional). If not specified, the project's `name` will be used.                                  |
+| `required_settings`   | A list of any configuration parameters that **must** be defined by the user                                                        |
+| `default_settings`    | A dictionary of configuration parameters and their default values                                                                  |
+| `django_apps`         | A list of additional Django apps to load alongside the plugin                                                                      |
+| `min_version`         | Minimum version of NetBox with which the plugin is compatible                                                                      |
+| `max_version`         | Maximum version of NetBox with which the plugin is compatible                                                                      |
+| `middleware`          | A list of middleware classes to append after NetBox's build-in middleware                                                          |
+| `queues`              | A list of custom background task queues to create                                                                                  |
+| `events_pipeline`     | A list of handlers to add to [`EVENTS_PIPELINE`](../../configuration/miscellaneous.md#events_pipeline), identified by dotted paths |
+| `search_extensions`   | The dotted path to the list of search index classes (default: `search.indexes`)                                                    |
+| `data_backends`       | The dotted path to the list of data source backend classes (default: `data_backends.backends`)                                     |
+| `template_extensions` | The dotted path to the list of template extension classes (default: `template_content.template_extensions`)                        |
+| `menu_items`          | The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`)                                |
+| `graphql_schema`      | The dotted path to the plugin's GraphQL schema class, if any (default: `graphql.schema`)                                           |
+| `user_preferences`    | The dotted path to the dictionary mapping of user preferences defined by the plugin (default: `preferences.preferences`)           |
 
 All required settings must be configured by the user. If a configuration parameter is listed in both `required_settings` and `default_settings`, the default setting will be ignored.
 

+ 4 - 0
mkdocs.yml

@@ -199,6 +199,7 @@ nav:
             - InventoryItemRole: 'models/dcim/inventoryitemrole.md'
             - InventoryItemTemplate: 'models/dcim/inventoryitemtemplate.md'
             - Location: 'models/dcim/location.md'
+            - MACAddress: 'models/dcim/macaddress.md'
             - Manufacturer: 'models/dcim/manufacturer.md'
             - Module: 'models/dcim/module.md'
             - ModuleBay: 'models/dcim/modulebay.md'
@@ -257,6 +258,8 @@ nav:
             - ServiceTemplate: 'models/ipam/servicetemplate.md'
             - VLAN: 'models/ipam/vlan.md'
             - VLANGroup: 'models/ipam/vlangroup.md'
+            - VLANTranslationPolicy: 'models/ipam/vlantranslationpolicy.md'
+            - VLANTranslationRule: 'models/ipam/vlantranslationrule.md'
             - VRF: 'models/ipam/vrf.md'
         - Tenancy:
             - Contact: 'models/tenancy/contact.md'
@@ -308,6 +311,7 @@ nav:
         - git Cheat Sheet: 'development/git-cheat-sheet.md'
     - Release Notes:
         - Summary: 'release-notes/index.md'
+        - Version 4.2: 'release-notes/version-4.2.md'
         - Version 4.1: 'release-notes/version-4.1.md'
         - Version 4.0: 'release-notes/version-4.0.md'
         - Version 3.7: 'release-notes/version-3.7.md'