Skip to content

Commit

Permalink
Documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
jeremystretch committed Dec 5, 2023
1 parent 8db1093 commit 1afac47
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 8 deletions.
8 changes: 6 additions & 2 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,24 +19,28 @@ NetBox was built specifically to serve the needs of network engineers and operat
* Device modeling using pre-defined types
* Virtual chassis and device contexts
* Network, power, and console cabling with SVG traces
* Breakout cables
* Power distribution modeling
* Data circuit and provider tracking
* Wireless LAN and point-to-point links
* L2 VPN overlays
* VPN tunnels
* IKE & IPSec policies
* Layer 2 VPN overlays
* FHRP groups (VRRP, HSRP, etc.)
* Application service bindings
* Virtual machines & clusters
* Flexible hierarchy for sites and locations
* Tenant ownership assignment
* Device & VM configuration contexts for advanced configuration rendering
* Custom fields for data model extension
* Custom validation rules
* Custom validation & protection rules
* Custom reports & scripts executable directly within the UI
* Extensive plugin framework for adding custom functionality
* Single sign-on (SSO) authentication
* Robust object-based permissions
* Detailed, automatic change logging
* Global search engine
* Event-driven scripts & webhooks

## What NetBox Is Not

Expand Down
Binary file added docs/media/misc/netbox_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/reference/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):
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:
![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):

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:
![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>

Expand Down
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ markdown_extensions:
- admonition
- attr_list
- 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:
custom_fences:
- name: mermaid
Expand Down Expand Up @@ -263,6 +263,7 @@ nav:
- L2VPN: 'models/vpn/l2vpn.md'
- L2VPNTermination: 'models/vpn/l2vpntermination.md'
- Tunnel: 'models/vpn/tunnel.md'
- TunnelGroup: 'models/vpn/tunnelgroup.md'
- TunnelTermination: 'models/vpn/tunneltermination.md'
- Wireless:
- WirelessLAN: 'models/wireless/wirelesslan.md'
Expand Down

0 comments on commit 1afac47

Please sign in to comment.