From 1afac47178dfd0a32de384ef3dec3796a428fbdd Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Tue, 5 Dec 2023 08:05:44 -0500 Subject: [PATCH] Documentation cleanup --- docs/introduction.md | 8 ++++++-- docs/media/misc/netbox_logo.png | Bin 0 -> 3903 bytes docs/reference/markdown.md | 8 ++++---- mkdocs.yml | 5 +++-- 4 files changed, 13 insertions(+), 8 deletions(-) create mode 100644 docs/media/misc/netbox_logo.png diff --git a/docs/introduction.md b/docs/introduction.md index 8f62d842a..b8442dad7 100644 --- a/docs/introduction.md +++ b/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 * 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 @@ -30,13 +33,14 @@ NetBox was built specifically to serve the needs of network engineers and operat * 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 diff --git a/docs/media/misc/netbox_logo.png b/docs/media/misc/netbox_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..c6e0a58e6259f957f2427afe1035e8e37a6d713c GIT binary patch literal 3903 zcmV-F55Vw=P);QDm*#fr%KqK!P0nLyf^QrJF@ufo-Ia-oDr|cl?w**KKYEg^KL%-w(R~w z8s#yYo1BN5S0 z*Rje11qSH2y9CI!4iG9OQJ`F>IS3pbeZC}=w=`^kv_zrahy8US%nJNX0_0i-NE$pB zk@HYtmo%p=Xgr#l3LG{F`4$O~cxepWk-v-`(;_JVAz#7|-EfcwvK&S_bjI&q z)atB21IY&8RJcVBm;{J-lm_3!&RBrF89QVfi(L5ON72Hh2?Yq{EEHJ5d<+$8wSl5i zlCwH+tia>i$pMo9@zQ1`C+>u)=#RpvDhy*e2e$z-4Q|GJ?zJgABwp{!L=D$ad=3g4 zs5r6ke9TDZ7*BxP;%?t0xCgH}kOd@EG%XeQeoW>2ZUTe~L`kz#7@a@!6UcWZr0#Aq z+>Y1muRZgxu@Cy==a+nt%<-lMkjAhU$};4xn(1ZY!THeFUjRTneiN+kkP98Gj^&<25!3p6@B)eJ3Cg{qT0g@hTj}&)K5LP#>*B z?S%6Ta;1n<(&6lllL3gY&x9(g;~enir~o0M^L_$ZU}ys+CqFU?k(p034M2Wf^n2Wm zyfh-&XuSTyU^ zUH?u^gV)4x-80%CH}MD{v2YEZ{{aJuohI?aV27Xs0aynJ`mqJ_>w>obC8D25hE(|2 za7+b$_XDfk0y*bLqBQCVEBq61<8(OQYB~UM^Qmy55r2S#F|&0|Rfvxz$pl?sv)-gu zoBb|mf>A3tW|L(^kW3}=tE{fgK~rPlmtACKA(3r8qy;x>EoR|b9bZBA#|#iP{LF{& z*prsetw163S42eMA)&0_b8}9IhfUYbK;O-HU4D(Bx;|QKG7lA)h1}FSsieSL!p3j` z*u)Ch+;-B*6d@I=2nNRw|HjXL4G17K`@VdhSWkS0)IS~$yJ*Y+#uvpg*HJNPVG zX&5j9+dMp{3!C{y!42AdXeO*Ow4;ET40Vyn$2D91S>#iOV?ScQ)$w4wM`y(M0XEsh^LOIJq;3o+B^NZ|R%%CD|I|~K>0p`1r)>Yse$TKw{8n3;XIrZiV|7nw{ zO6?}|ocD|II@|FXIz*3LD6la?&2zv6vB5p;OoW7nd3nHK20rBR@N7kOR@{k8X+Qwk z%ml-HY%^?swm^_GOvlosqrhUr#6*HQNjRHPZc2rK;kwm0J`cJc#R>^oDm)~NDADAm z!b^DEe+}nV;(2W%CWSO+a-KDS?=XvA8BNBJ&%l2xH?-$Gi?D*gA0cNuvR`RDR+%g% zt_k}&6@(V7A%1uT|6asyPEn&Mg6Tq{u&Fj9UDbFRd+6jv`HTR$jD0i0GW5vvNyiL> z`L4js=xkccLcRzIw{@=SIRRKRJqYuDir@V@ga%a$vpCN$&L0VFfYxsC-Ue~kP#JEvQLQo}iW1g1bw zlcpgcaWi131!o9^WUU7pq(W%Un4f*PpnZ$OzvnTZ%ecU8r=#d3?OvloiQ(K*76B9i zN`;@Wh@X`orNH}+B8(CsF$3hELbE0^nzB1;fFTVvbYdcVJDH#2ERacvHI+}t${G7#}Xb%aHH~_-) z7^3J{RgApD6h=U!@2E9BLnJwF{^s!SWC|KfRs8UdqdGHQtGCn?B@_8C z+z07tnTX_CWKlRoF9FgZO{|^~s^{ zy#d1Opj2C5VLY_PWBy?hM5;=T%u!4i)Nd(KH5AE#Ihj3An63B2Zv-GO7368ET;F+9 z0;HY*p(qQ#wsDqQ#HyQ(c>(SK-xbay@T6fUq5aOQ63T>|=+P`*pG2Vo|FTTxO+j#| zkSi!UJYo`Ht~o1A)dPO`sc>?j>R`Tujj>Iqgf&@If@033Q_JBlA=qL@8Q)O-5D@=iT@=*Tb7xkcYFdV z5%?S97_g@>%^EO)Q-$%?wOA4$$pZ+@=6qd=NEk0`rS-?yY-v>zPBm5HYrkkyYI6* zpqS-Q>YlHgpib=we*Z0Z08(5Bkenh|H8)8BnYjmUnpFU|64U!h680h=Hvv*-moKuI zCG9F|&!Yx-!KNL}v~?@B2`G23ilH38TB``S+qPeMZP`A7Ku0Ul-@^(X%~7kqf{O4n zOskl~#j4=Ge^0m;$=VKW5frJqT^08t4~YBSATa<$DTV8@gU}y&F?*3u0QTkps*NJ8X8D-#e!`-W^a-$Uw)A)>|9S ziPhZWS>O}~f)LaHahZ*}wuG-`aXqkkW_`Qzb#04#BMq%x`e$~0ZBc(aXb;3WPIiRC zR}$p~Iy8fSSRd}b2r5$2p_aJ&La4Ajwg?WQrnqYJrmGqRY7d_zNnTU57wE*py%z&C zRsm9wd%Y3o^$O8>lO)M&(j4-J4vAHF;O^Y8??y_LjT+V zq+uJB>>_wP>wRboAYY3h$vda~HZ)mQ>omo=++ujXpddksl{f$*Nm5dYatTyMqBo;Z zlZ?qLv)Ch60z}gPjajt~?ngju)PbXNb`ks{Z=FlvkN}bNS)sf_xCb@GdzAPK`5gH9 zv;r<~;wAwisbLW`qS`8Sa-Tr}EJR*{U>Ji=`Fj29oe?Y}U46YX746aXnY0~b-5#y0 zGNGc>G!1dRAu7BX6(FfD??53*lF9!FKpzCa30nDG)9Dbi4@m3>AlDs4;>dOkiBM6EaRE&sD`@2+lh}z|`xHn*kts#xrwk&-8bRK*C z7OlZ{b7L<_lAIFNR?%9I-xoux`6V7~>}y4&v1su>y>LY)2qh(n{s+0RRR22fatZ(d N002ovPDHLkV1j7+9Wwv` literal 0 HcmV?d00001 diff --git a/docs/reference/markdown.md b/docs/reference/markdown.md index 7f280686d..0759fa2ec 100644 --- a/docs/reference/markdown.md +++ b/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): 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" diff --git a/mkdocs.yml b/mkdocs.yml index 45f9fe7d1..5a7e00c2c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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'