Răsfoiți Sursa

Documentation cleanup

Jeremy Stretch 2 ani în urmă
părinte
comite
1afac47178
4 a modificat fișierele cu 13 adăugiri și 8 ștergeri
  1. 6 2
      docs/introduction.md
  2. BIN
      docs/media/misc/netbox_logo.png
  3. 4 4
      docs/reference/markdown.md
  4. 3 2
      mkdocs.yml

+ 6 - 2
docs/introduction.md

@@ -19,10 +19,13 @@ NetBox was built specifically to serve the needs of network engineers and operat
 * Device modeling using pre-defined types
 * Device modeling using pre-defined types
 * Virtual chassis and device contexts
 * Virtual chassis and device contexts
 * Network, power, and console cabling with SVG traces
 * Network, power, and console cabling with SVG traces
+* Breakout cables
 * Power distribution modeling
 * Power distribution modeling
 * Data circuit and provider tracking
 * Data circuit and provider tracking
 * Wireless LAN and point-to-point links
 * Wireless LAN and point-to-point links
-* L2 VPN overlays
+* VPN tunnels
+* IKE & IPSec policies
+* Layer 2 VPN overlays
 * FHRP groups (VRRP, HSRP, etc.)
 * FHRP groups (VRRP, HSRP, etc.)
 * Application service bindings
 * Application service bindings
 * Virtual machines & clusters
 * Virtual machines & clusters
@@ -30,13 +33,14 @@ NetBox was built specifically to serve the needs of network engineers and operat
 * Tenant ownership assignment
 * Tenant ownership assignment
 * Device & VM configuration contexts for advanced configuration rendering
 * Device & VM configuration contexts for advanced configuration rendering
 * Custom fields for data model extension
 * Custom fields for data model extension
-* Custom validation rules
+* Custom validation & protection rules
 * Custom reports & scripts executable directly within the UI
 * Custom reports & scripts executable directly within the UI
 * Extensive plugin framework for adding custom functionality
 * Extensive plugin framework for adding custom functionality
 * Single sign-on (SSO) authentication
 * Single sign-on (SSO) authentication
 * Robust object-based permissions
 * Robust object-based permissions
 * Detailed, automatic change logging
 * Detailed, automatic change logging
 * Global search engine
 * Global search engine
+* Event-driven scripts & webhooks
 
 
 ## What NetBox Is Not
 ## What NetBox Is Not
 
 

BIN
docs/media/misc/netbox_logo.png


+ 4 - 4
docs/reference/markdown.md

@@ -171,23 +171,23 @@ Some text to show that the reference links can follow later.
 Here's the NetBox logo (hover to see the title text):
 Here's the NetBox logo (hover to see the title text):
 
 
 Inline-style: 
 Inline-style: 
-![alt text](/static/netbox_logo.png "Logo Title Text 1")
+![alt text](/media/misc/netbox_logo.png "Logo Title Text 1")
 
 
 Reference-style: 
 Reference-style: 
 ![alt text][logo]
 ![alt text][logo]
 
 
-[logo]: /static/netbox_logo.png "Logo Title Text 2"
+[logo]: /media/misc/netbox_logo.png "Logo Title Text 2"
 ```
 ```
 
 
 Here's the NetBox logo (hover to see the title text):
 Here's the NetBox logo (hover to see the title text):
 
 
 Inline-style: 
 Inline-style: 
-![alt text](/static/netbox_logo.png "Logo Title Text 1")
+![alt text](../media/misc/netbox_logo.png "Logo Title Text 1")
 
 
 Reference-style: 
 Reference-style: 
 ![alt text][logo]
 ![alt text][logo]
 
 
-[logo]: /static/netbox_logo.png "Logo Title Text 2"
+[logo]: ../media/misc/netbox_logo.png "Logo Title Text 2"
 
 
 <a name="code"></a>
 <a name="code"></a>
 
 

+ 3 - 2
mkdocs.yml

@@ -53,8 +53,8 @@ markdown_extensions:
     - admonition
     - admonition
     - attr_list
     - attr_list
     - pymdownx.emoji:
     - pymdownx.emoji:
-        emoji_index: !!python/name:materialx.emoji.twemoji
-        emoji_generator: !!python/name:materialx.emoji.to_svg
+        emoji_index: !!python/name:material.extensions.emoji.twemoji
+        emoji_generator: !!python/name:material.extensions.emoji.to_svg
     - pymdownx.superfences:
     - pymdownx.superfences:
         custom_fences:
         custom_fences:
           - name: mermaid
           - name: mermaid
@@ -263,6 +263,7 @@ nav:
             - L2VPN: 'models/vpn/l2vpn.md'
             - L2VPN: 'models/vpn/l2vpn.md'
             - L2VPNTermination: 'models/vpn/l2vpntermination.md'
             - L2VPNTermination: 'models/vpn/l2vpntermination.md'
             - Tunnel: 'models/vpn/tunnel.md'
             - Tunnel: 'models/vpn/tunnel.md'
+            - TunnelGroup: 'models/vpn/tunnelgroup.md'
             - TunnelTermination: 'models/vpn/tunneltermination.md'
             - TunnelTermination: 'models/vpn/tunneltermination.md'
         - Wireless:
         - Wireless:
             - WirelessLAN: 'models/wireless/wirelesslan.md'
             - WirelessLAN: 'models/wireless/wirelesslan.md'