Przeglądaj źródła

Add hyperlinks to Mermaid graphs

jeremystretch 3 lat temu
rodzic
commit
9c667bb3af

+ 6 - 0
docs/features/circuits.md

@@ -7,6 +7,12 @@ flowchart TD
     ASN --> Provider
     Provider --> ProviderNetwork & Circuit
     CircuitType --> Circuit
+
+click ASN "../../models/circuits/asn/"
+click Circuit "../../models/circuits/circuit/"
+click CircuitType "../../models/circuits/circuittype/"
+click Provider "../../models/circuits/provider/"
+click ProviderNetwork "../../models/circuits/providernetwork/"
 ```
 
 ## Providers

+ 4 - 0
docs/features/contacts.md

@@ -7,6 +7,10 @@ flowchart TD
     ContactGroup --> ContactGroup & Contact
     ContactRole & Contact --> assignment([Assignment])
     assignment --> Object
+
+click Contact "../../models/tenancy/contact/"
+click ContactGroup "../../models/tenancy/contactgroup/"
+click ContactRole "../../models/tenancy/contactrole/"
 ```
 
 ## Contact Groups

+ 8 - 0
docs/features/devices-cabling.md

@@ -11,6 +11,14 @@ flowchart TD
     DeviceRole & Platform & DeviceType --> Device
     Device & ModuleType ---> Module
     Device & Module --> Interface & ConsolePort & PowerPort & ...
+
+click Device "../../models/dcim/device/"
+click DeviceRole "../../models/dcim/devicerole/"
+click DeviceType "../../models/dcim/devicetype/"
+click Manufacturer "../../models/dcim/manufacturer/"
+click Module "../../models/dcim/module/"
+click ModuleType "../../models/dcim/moduletype/"
+click Platform "../../models/dcim/platform/"
 ```
 
 ## Manufacturers

+ 8 - 0
docs/features/facilities.md

@@ -13,6 +13,14 @@ flowchart TD
     Rack --> Device
     Site --> Rack
     RackRole --> Rack
+
+click Device "../../models/dcim/device/"
+click Location "../../models/dcim/location/"
+click Rack "../../models/dcim/rack/"
+click RackRole "../../models/dcim/rackrole/"
+click Region "../../models/dcim/region/"
+click Site "../../models/dcim/site/"
+click SiteGroup "../../models/dcim/sitegroup/"
 ```
 
 ## Regions

+ 8 - 1
docs/features/ipam.md

@@ -17,8 +17,15 @@ flowchart TD
     Aggregate & Role --> Prefix
     Prefix --> Prefix
     Prefix --> IPRange & IPAddress
+
+click Aggregate "../../models/ipam/aggregate/"
+click IPAddress "../../models/ipam/ipaddress/"
+click IPRange "../../models/ipam/iprange/"
+click Prefix "../../models/ipam/prefix/"
+click RIR "../../models/ipam/rir/"
+click Role "../../models/ipam/role/"
 ```
-    
+
 !!! tip "Automatic Hierarchies"
     IP objects in NetBox never need to be manually assigned to the parent objects. The construction of hierarchies is handled automatically by the application according to the inherent rules of IP addressing.
 

+ 3 - 0
docs/features/tenancy.md

@@ -6,6 +6,9 @@ Most core objects within NetBox's data model support _tenancy_. This is the asso
 flowchart TD
     TenantGroup --> TenantGroup & Tenant
     Tenant --> Site & Device & Prefix & Circuit & ...
+
+click Tenant "../../models/tenancy/tenant/"
+click TenantGroup "../../models/tenancy/tenantgroup/"
 ```
 
 ## Tenant Groups

+ 4 - 0
docs/features/vlan-management.md

@@ -5,6 +5,10 @@ Complementing its IPAM capabilities, NetBox also tracks VLAN information to assi
 ```mermaid
 flowchart TD
     VLANGroup & Role --> VLAN
+
+click Role "../../models/ipam/role/"
+click VLAN "../../models/ipam/vlan/"
+click VLANGroup "../../models/ipam/vlangroup/"
 ```
 
 ## VLAN Groups

+ 3 - 0
docs/features/wireless.md

@@ -7,6 +7,9 @@ Just as NetBox provides robust modeling for physical cable plants, it also suppo
 ```mermaid
 flowchart TD
     WirelessLANGroup --> WirelessLANGroup & WirelessLAN
+
+click WirelessLAN "../../models/wireless/wirelesslan/"
+click WirelessLANGroup "../../models/wireless/wirelesslangroup/"
 ```
 
 A wireless LAN is a multi-access network shared by multiple wireless clients, identified by a common service set identifier (SSID) and authentication parameters. Wireless LANs can be organized into self-nesting groups, and each wireless LAN may optionally be bound to a particular VLAN. This allows easily mapping wireless networks to their wired counterparts.

+ 47 - 2
docs/getting-started/planning.md

@@ -78,9 +78,15 @@ The graphs below illustrate some of the core dependencies among different models
 
 ```mermaid
 flowchart TD
-    TenantGroup --> TenantGroup
-    TenantGroup --> Tenant
+    TenantGroup --> TenantGroup & Tenant
     Tenant --> Site & Device & Prefix & VLAN & ...
+
+click Device "../../models/dcim/device/"
+click Prefix "../../models/ipam/prefix/"
+click Site "../../models/dcim/site/"
+click Tenant "../../models/tenancy/tenant/"
+click TenantGroup "../../models/tenancy/tenantgroup/"
+click VLAN "../../models/ipam/vlan/"
 ```
 
 ### Sites, Racks, and Devices
@@ -99,6 +105,21 @@ flowchart TD
     DeviceType  --> Device
     Device & ModuleType ---> Module
     Device & Module --> Interface
+
+click Device "../../models/dcim/device/"
+click DeviceRole "../../models/dcim/devicerole/"
+click DeviceType "../../models/dcim/devicetype/"
+click Interface "../../models/dcim/interface/"
+click Location "../../models/dcim/location/"
+click Manufacturer "../../models/dcim/manufacturer/"
+click Module "../../models/dcim/module/"
+click ModuleType "../../models/dcim/moduletype/"
+click Platform "../../models/dcim/platform/"
+click Rack "../../models/dcim/rack/"
+click RackRole "../../models/dcim/rackrole/"
+click Region "../../models/dcim/region/"
+click Site "../../models/dcim/site/"
+click SiteGroup "../../models/dcim/sitegroup/"
 ```
 
 ### VRFs, Prefixes, IP Addresses, and VLANs
@@ -112,6 +133,16 @@ flowchart TD
     Aggregate & VRF --> Prefix
     VRF --> IPRange & IPAddress
     Prefix --> VLAN & IPRange & IPAddress
+
+click Aggregate "../../models/ipam/aggregate/"
+click IPAddress "../../models/ipam/ipaddress/"
+click IPRange "../../models/ipam/iprange/"
+click Prefix "../../models/ipam/prefix/"
+click RIR "../../models/ipam/rir/"
+click Role "../../models/ipam/role/"
+click VLAN "../../models/ipam/vlan/"
+click VLANGroup "../../models/ipam/vlangroup/"
+click VRF "../../models/ipam/vrf/"
 ```
 
 ### Circuits
@@ -121,6 +152,12 @@ flowchart TD
     Provider & CircuitType --> Circuit
     Provider --> ProviderNetwork
     Circuit --> CircuitTermination
+
+click Circuit "../../models/circuits/circuit/"
+click CircuitTermination "../../models/circuits/circuittermination/"
+click CircuitType "../../models/circuits/circuittype/"
+click Provider "../../models/circuits/provider/"
+click ProviderNetwork "../../models/circuits/providernetwork/"
 ```
 
 ### Clusters and Virtual Machines
@@ -132,4 +169,12 @@ flowchart TD
     Site --> Cluster & VirtualMachine
     Device & Platform --> VirtualMachine
     VirtualMachine --> VMInterface
+
+click Cluster "../../models/virtualization/cluster/"
+click ClusterGroup "../../models/virtualization/clustergroup/"
+click ClusterType "../../models/virtualization/clustertype/"
+click Device "../../models/dcim/device/"
+click Platform "../../models/dcim/platform/"
+click VirtualMachine "../../models/virtualization/virtualmachine/"
+click VMInterface "../../models/virtualization/vminterface/"
 ```