diff --git a/docs/core-functionality/circuits.md b/docs/core-functionality/circuits.md index 63a1a5204..43b911308 100644 --- a/docs/core-functionality/circuits.md +++ b/docs/core-functionality/circuits.md @@ -1,3 +1,5 @@ +# Circuits + {!docs/models/circuits/provider.md!} --- diff --git a/docs/core-functionality/device-types.md b/docs/core-functionality/device-types.md index 0f59ac84e..a965f51f0 100644 --- a/docs/core-functionality/device-types.md +++ b/docs/core-functionality/device-types.md @@ -1,3 +1,5 @@ +# Device Types + {!docs/models/dcim/devicetype.md!} {!docs/models/dcim/manufacturer.md!} @@ -27,3 +29,12 @@ Once component templates have been created, every new device that you create as !!! note Assignment of components from templates occurs only at the time of device creation. If you modify the templates of a device type, it will not affect devices which have already been created. However, you always have the option of adding, modifying, or deleting components on existing devices. + +{!docs/models/dcim/consoleporttemplate.md!} +{!docs/models/dcim/consoleserverporttemplate.md!} +{!docs/models/dcim/powerporttemplate.md!} +{!docs/models/dcim/poweroutlettemplate.md!} +{!docs/models/dcim/interfacetemplate.md!} +{!docs/models/dcim/frontporttemplate.md!} +{!docs/models/dcim/rearporttemplate.md!} +{!docs/models/dcim/devicebaytemplate.md!} diff --git a/docs/core-functionality/devices.md b/docs/core-functionality/devices.md index 2ceb5dc6f..96dcf866d 100644 --- a/docs/core-functionality/devices.md +++ b/docs/core-functionality/devices.md @@ -1,9 +1,13 @@ +# Devices and Cabling + {!docs/models/dcim/device.md!} {!docs/models/dcim/devicerole.md!} {!docs/models/dcim/platform.md!} --- +## Device Components + {!docs/models/dcim/consoleport.md!} {!docs/models/dcim/consoleserverport.md!} {!docs/models/dcim/powerport.md!} diff --git a/docs/core-functionality/ipam.md b/docs/core-functionality/ipam.md index 2103ee71f..38572cb25 100644 --- a/docs/core-functionality/ipam.md +++ b/docs/core-functionality/ipam.md @@ -1,3 +1,5 @@ +# IP Address Management + {!docs/models/ipam/aggregate.md!} {!docs/models/ipam/rir.md!} diff --git a/docs/core-functionality/power.md b/docs/core-functionality/power.md index b5d4ff991..026acd602 100644 --- a/docs/core-functionality/power.md +++ b/docs/core-functionality/power.md @@ -1,3 +1,5 @@ +# Power Tracking + {!docs/models/dcim/powerpanel.md!} {!docs/models/dcim/powerfeed.md!} diff --git a/docs/core-functionality/secrets.md b/docs/core-functionality/secrets.md index 64944c2d8..68771310c 100644 --- a/docs/core-functionality/secrets.md +++ b/docs/core-functionality/secrets.md @@ -1,3 +1,5 @@ +# Secrets + {!docs/models/secrets/secret.md!} {!docs/models/secrets/secretrole.md!} diff --git a/docs/core-functionality/services.md b/docs/core-functionality/services.md index f7b71d296..4d4256081 100644 --- a/docs/core-functionality/services.md +++ b/docs/core-functionality/services.md @@ -1 +1,3 @@ +# Service Mapping + {!docs/models/ipam/service.md!} diff --git a/docs/core-functionality/sites-and-racks.md b/docs/core-functionality/sites-and-racks.md index 54c65279e..073756fa1 100644 --- a/docs/core-functionality/sites-and-racks.md +++ b/docs/core-functionality/sites-and-racks.md @@ -1,3 +1,5 @@ +# Sites and Racks + {!docs/models/dcim/site.md!} {!docs/models/dcim/region.md!} diff --git a/docs/core-functionality/tenancy.md b/docs/core-functionality/tenancy.md index e877745ca..540955698 100644 --- a/docs/core-functionality/tenancy.md +++ b/docs/core-functionality/tenancy.md @@ -1,2 +1,4 @@ +# Tenancy Assignment + {!docs/models/tenancy/tenant.md!} {!docs/models/tenancy/tenantgroup.md!} diff --git a/docs/core-functionality/virtual-machines.md b/docs/core-functionality/virtualization.md similarity index 85% rename from docs/core-functionality/virtual-machines.md rename to docs/core-functionality/virtualization.md index cb76a7885..b2bab2b7d 100644 --- a/docs/core-functionality/virtual-machines.md +++ b/docs/core-functionality/virtualization.md @@ -1,3 +1,5 @@ +# Virtual Machines and Clusters + {!docs/models/virtualization/cluster.md!} {!docs/models/virtualization/clustertype.md!} {!docs/models/virtualization/clustergroup.md!} diff --git a/docs/core-functionality/vlans.md b/docs/core-functionality/vlans.md index 03550ada4..cf1c73fe3 100644 --- a/docs/core-functionality/vlans.md +++ b/docs/core-functionality/vlans.md @@ -1,2 +1,4 @@ +# VLAN Management + {!docs/models/ipam/vlan.md!} {!docs/models/ipam/vlangroup.md!} diff --git a/docs/models/dcim/consoleport.md b/docs/models/dcim/consoleport.md index bcab4ddd0..4d3a089c5 100644 --- a/docs/models/dcim/consoleport.md +++ b/docs/models/dcim/consoleport.md @@ -1,4 +1,4 @@ -# Console Ports +## Console Ports A console port provides connectivity to the physical console of a device. Console ports are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access via a console server. diff --git a/docs/models/dcim/consoleporttemplate.md b/docs/models/dcim/consoleporttemplate.md index 3dec8d773..86281cb92 100644 --- a/docs/models/dcim/consoleporttemplate.md +++ b/docs/models/dcim/consoleporttemplate.md @@ -1,3 +1,3 @@ -# Console Port Templates +## Console Port Templates A template for a console port that will be created on all instantiations of the parent device type. diff --git a/docs/models/dcim/consoleserverport.md b/docs/models/dcim/consoleserverport.md index 855084e23..55aefd733 100644 --- a/docs/models/dcim/consoleserverport.md +++ b/docs/models/dcim/consoleserverport.md @@ -1,4 +1,4 @@ -# Console Server Ports +## Console Server Ports A console server is a device which provides remote access to the local consoles of connected devices. This is typically done to provide remote out-of-band access to network devices. diff --git a/docs/models/dcim/consoleserverporttemplate.md b/docs/models/dcim/consoleserverporttemplate.md index 66e9000cc..ed99adb11 100644 --- a/docs/models/dcim/consoleserverporttemplate.md +++ b/docs/models/dcim/consoleserverporttemplate.md @@ -1,3 +1,3 @@ -# Console Server Port Templates +## Console Server Port Templates A template for a console server port that will be created on all instantiations of the parent device type. diff --git a/docs/models/dcim/devicebay.md b/docs/models/dcim/devicebay.md index 453b424f4..cdcd5657d 100644 --- a/docs/models/dcim/devicebay.md +++ b/docs/models/dcim/devicebay.md @@ -1,4 +1,4 @@ -# Device Bays +## Device Bays Device bays represent the ability of a device to house child devices. For example, you might install four blade servers into a 2U chassis. The chassis would appear in the rack elevation as a 2U device with four device bays. Each server within it would be defined as a 0U device installed in one of the device bays. Child devices do not appear within rack elevations or the "Non-Racked Devices" list within the rack view. diff --git a/docs/models/dcim/devicebaytemplate.md b/docs/models/dcim/devicebaytemplate.md index d7c29755b..ebf7bd63c 100644 --- a/docs/models/dcim/devicebaytemplate.md +++ b/docs/models/dcim/devicebaytemplate.md @@ -1,3 +1,3 @@ -# Device Bay Templates +## Device Bay Templates A template for a device bay that will be created on all instantiations of the parent device type. diff --git a/docs/models/dcim/frontport.md b/docs/models/dcim/frontport.md index 5719025b6..12b9cfc16 100644 --- a/docs/models/dcim/frontport.md +++ b/docs/models/dcim/frontport.md @@ -1,4 +1,4 @@ -# Front Ports +## Front Ports Front ports are pass-through ports used to represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. diff --git a/docs/models/dcim/frontporttemplate.md b/docs/models/dcim/frontporttemplate.md index 3c036879e..b32349519 100644 --- a/docs/models/dcim/frontporttemplate.md +++ b/docs/models/dcim/frontporttemplate.md @@ -1,3 +1,3 @@ -# Front Port Templates +## Front Port Templates A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. diff --git a/docs/models/dcim/interface.md b/docs/models/dcim/interface.md index 9d3c0b78c..cbccbec8d 100644 --- a/docs/models/dcim/interface.md +++ b/docs/models/dcim/interface.md @@ -1,4 +1,4 @@ -# Interfaces +## Interfaces Interfaces connect to one another in a symmetric manner: If interface A connects to interface B, interface B therefore connects to interface A. Each type of connection can be classified as either *planned* or *connected*. diff --git a/docs/models/dcim/interfacetemplate.md b/docs/models/dcim/interfacetemplate.md index 8ba2c8ee8..07fc3a65b 100644 --- a/docs/models/dcim/interfacetemplate.md +++ b/docs/models/dcim/interfacetemplate.md @@ -1,3 +1,3 @@ -# Interface Templates +## Interface Templates A template for an interface that will be created on all instantiations of the parent device type. diff --git a/docs/models/dcim/poweroutlet.md b/docs/models/dcim/poweroutlet.md index ef2891a97..0ec93856e 100644 --- a/docs/models/dcim/poweroutlet.md +++ b/docs/models/dcim/poweroutlet.md @@ -1,3 +1,3 @@ -# Power Outlets +## Power Outlets Power outlets represent the ports on a PDU that supply power to other devices. Power outlets are downstream-facing towards power ports. A power outlet can be associated with a power port on the same device and a feed leg (i.e. in a case of a three-phase supply). This indicates which power port supplies power to a power outlet. diff --git a/docs/models/dcim/poweroutlettemplate.md b/docs/models/dcim/poweroutlettemplate.md index 9928c2345..e5b54af23 100644 --- a/docs/models/dcim/poweroutlettemplate.md +++ b/docs/models/dcim/poweroutlettemplate.md @@ -1,3 +1,3 @@ -# Power Outlet Templates +## Power Outlet Templates A template for a power outlet that will be created on all instantiations of the parent device type. diff --git a/docs/models/dcim/powerport.md b/docs/models/dcim/powerport.md index ef115505d..6027fa98b 100644 --- a/docs/models/dcim/powerport.md +++ b/docs/models/dcim/powerport.md @@ -1,4 +1,4 @@ -# Power Ports +## Power Ports A power port is the inlet of a device where it draws its power. Power ports are upstream-facing towards power outlets. Alternatively, a power port can connect to a power feed – as mentioned in the power feed section – to indicate the power source of a PDU's inlet. diff --git a/docs/models/dcim/powerporttemplate.md b/docs/models/dcim/powerporttemplate.md index bfaaece29..b6e64be01 100644 --- a/docs/models/dcim/powerporttemplate.md +++ b/docs/models/dcim/powerporttemplate.md @@ -1,3 +1,3 @@ -# Power Port Templates +## Power Port Templates A template for a power port that will be created on all instantiations of the parent device type. diff --git a/docs/models/dcim/rearport.md b/docs/models/dcim/rearport.md index 5d6171c8d..8c8136338 100644 --- a/docs/models/dcim/rearport.md +++ b/docs/models/dcim/rearport.md @@ -1,4 +1,4 @@ -# Rear Ports +## Rear Ports Like front ports, rear ports are pass-through ports which represent the end of a particular cable segment in a path. Each rear port is defined with a number of positions: rear ports with more than one position can be mapped to multiple front ports. This can be useful for modeling instances where multiple paths share a common cable (for example, six different fiber connections sharing a 12-strand MPO cable). diff --git a/docs/models/dcim/rearporttemplate.md b/docs/models/dcim/rearporttemplate.md index 73415b4ff..448c0befd 100644 --- a/docs/models/dcim/rearporttemplate.md +++ b/docs/models/dcim/rearporttemplate.md @@ -1,3 +1,3 @@ -# Rear Port Templates +## Rear Port Templates A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. diff --git a/mkdocs.yml b/mkdocs.yml index 9747f450f..5dc45da16 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,7 @@ python: - requirements: docs/requirements.txt theme: name: readthedocs - navigation_depth: 3 + navigation_depth: 6 markdown_extensions: - admonition: - markdown_include.include: @@ -29,16 +29,16 @@ nav: - Optional Settings: 'configuration/optional-settings.md' - Core Functionality: - IP Address Management: 'core-functionality/ipam.md' - - VLANs: 'core-functionality/vlans.md' + - VLAN Management: 'core-functionality/vlans.md' - Sites and Racks: 'core-functionality/sites-and-racks.md' - - Devices: 'core-functionality/devices.md' + - Devices and Cabling: 'core-functionality/devices.md' - Device Types: 'core-functionality/device-types.md' - - Virtual Machines: 'core-functionality/virtual-machines.md' - - Services: 'core-functionality/services.md' + - Virtualization: 'core-functionality/virtualization.md' + - Service Mapping: 'core-functionality/services.md' - Circuits: 'core-functionality/circuits.md' - - Power: 'core-functionality/power.md' + - Power Tracking: 'core-functionality/power.md' - Secrets: 'core-functionality/secrets.md' - - Tenancy: 'core-functionality/tenancy.md' + - Tenancy Assignment: 'core-functionality/tenancy.md' - Additional Features: - Caching: 'additional-features/caching.md' - Change Logging: 'additional-features/change-logging.md'