From 0fb8291b8b641a0b507661019694702c86cc9052 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 14 Apr 2021 15:21:30 -0400 Subject: [PATCH] Documentation cleanup --- docs/development/models.md | 4 +++- docs/models/circuits/providernetwork.md | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/development/models.md b/docs/development/models.md index 1e9b17d22..7dec2cb61 100644 --- a/docs/development/models.md +++ b/docs/development/models.md @@ -4,13 +4,15 @@ A NetBox model represents a discrete object type such as a device or IP address. Each model is defined as a Python class and has its own SQL table. All NetBox data models can be categorized by type. +The Django [content types](https://docs.djangoproject.com/en/stable/ref/contrib/contenttypes/) framework can be used to reference models within the database. A ContentType instance references a model by its `app_label` and `name`: For example, the Site model is referred to as `dcim.site`. The content type combined with an object's primary key form a globally unique identifier for the object (e.g. `dcim.site:123`). + ### Features Matrix * [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 -* Tagging - The models can be tagged with user-defined tags +* [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/models/circuits/providernetwork.md b/docs/models/circuits/providernetwork.md index 970a9f8a8..f5a428e96 100644 --- a/docs/models/circuits/providernetwork.md +++ b/docs/models/circuits/providernetwork.md @@ -1,4 +1,4 @@ -# Provider Network +# Provider Networks This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it might represent a provider's regional MPLS network to which multiple circuits provide connectivity.