瀏覽代碼

#14311: Update model documentation

Jeremy Stretch 2 年之前
父節點
當前提交
c0512e2c36
共有 4 個文件被更改,包括 22 次插入22 次删除
  1. 0 18
      docs/models/ipam/l2vpntermination.md
  2. 2 2
      docs/models/vpn/l2vpn.md
  3. 18 0
      docs/models/vpn/l2vpntermination.md
  4. 2 2
      mkdocs.yml

+ 0 - 18
docs/models/ipam/l2vpntermination.md

@@ -1,18 +0,0 @@
-# L2VPN Termination
-
-A L2VPN termination is the attachment of an [L2VPN](./l2vpn.md) to an [interface](../dcim/interface.md) or [VLAN](./vlan.md). Note that the L2VPNs of the following types may have only two terminations assigned to them:
-
-* VPWS
-* EPL
-* EP-LAN
-* EP-TREE
-
-## Fields
-
-### L2VPN
-
-The [L2VPN](./l2vpn.md) instance.
-
-### VLAN or Interface
-
-The [VLAN](./vlan.md), [device interface](../dcim/interface.md), or [virtual machine interface](../virtualization/virtualmachine.md) attached to the L2VPN.

+ 2 - 2
docs/models/ipam/l2vpn.md → docs/models/vpn/l2vpn.md

@@ -1,6 +1,6 @@
 # L2VPN
 
-A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by an optional unique identifier (VNI would be an example). Once created, L2VPNs can be terminated to [interfaces](../dcim/interface.md) and [VLANs](./vlan.md).
+A L2VPN object is NetBox is a representation of a layer 2 bridge technology such as VXLAN, VPLS, or EPL. Each L2VPN can be identified by name as well as by an optional unique identifier (VNI would be an example). Once created, L2VPNs can be terminated to [interfaces](../dcim/interface.md) and [VLANs](../ipam/vlan.md).
 
 ## Fields
 
@@ -38,4 +38,4 @@ An optional numeric identifier. This can be used to track a pseudowire ID, for e
 
 ### Import & Export Targets
 
-The [route targets](./routetarget.md) associated with this L2VPN to control the import and export of forwarding information.
+The [route targets](../ipam/routetarget.md) associated with this L2VPN to control the import and export of forwarding information.

+ 18 - 0
docs/models/vpn/l2vpntermination.md

@@ -0,0 +1,18 @@
+# L2VPN Termination
+
+A L2VPN termination is the attachment of an [L2VPN](./l2vpn.md) to an [interface](../dcim/interface.md) or [VLAN](../ipam/vlan.md). Note that the L2VPNs of the following types may have only two terminations assigned to them:
+
+* VPWS
+* EPL
+* EP-LAN
+* EP-TREE
+
+## Fields
+
+### L2VPN
+
+The [L2VPN](./l2vpn.md) instance.
+
+### VLAN or Interface
+
+The [VLAN](../ipam/vlan.md), [device interface](../dcim/interface.md), or [virtual machine interface](../virtualization/virtualmachine.md) attached to the L2VPN.

+ 2 - 2
mkdocs.yml

@@ -232,8 +232,6 @@ nav:
             - FHRPGroupAssignment: 'models/ipam/fhrpgroupassignment.md'
             - IPAddress: 'models/ipam/ipaddress.md'
             - IPRange: 'models/ipam/iprange.md'
-            - L2VPN: 'models/ipam/l2vpn.md'
-            - L2VPNTermination: 'models/ipam/l2vpntermination.md'
             - Prefix: 'models/ipam/prefix.md'
             - RIR: 'models/ipam/rir.md'
             - Role: 'models/ipam/role.md'
@@ -262,6 +260,8 @@ nav:
             - IPSecPolicy: 'models/vpn/ipsecpolicy.md'
             - IPSecProfile: 'models/vpn/ipsecprofile.md'
             - IPSecProposal: 'models/vpn/ipsecproposal.md'
+            - L2VPN: 'models/vpn/l2vpn.md'
+            - L2VPNTermination: 'models/vpn/l2vpntermination.md'
             - Tunnel: 'models/vpn/tunnel.md'
             - TunnelTermination: 'models/vpn/tunneltermination.md'
         - Wireless: