From 2dc2f24a37daf8ca5c1c367b0bd54ca93ad7b20c Mon Sep 17 00:00:00 2001 From: pa Date: Sat, 20 Apr 2024 20:47:57 +0000 Subject: [PATCH] restructure mkdocs --- .../{images => img}/account_settings.png | Bin .../{images => img}/codespaces-secrets.png | Bin docs/{ => assets}/stylesheets/extra.css | 0 .../avd-extended-workshop-part-1.md | 0 .../avd-extended-workshop.md} | 0 docs/cvaas/avd-evpn-aa.md | 49 ------------------ .../avd-evpn-active-active.md} | 0 .../avd-evpn-mlag}/avd-evpn-mlag.md | 0 docs/index.md | 4 +- mkdocs.yml | 18 ++++--- 10 files changed, 12 insertions(+), 59 deletions(-) rename docs/assets/{images => img}/account_settings.png (100%) rename docs/assets/{images => img}/codespaces-secrets.png (100%) rename docs/{ => assets}/stylesheets/extra.css (100%) rename docs/avd/{ => workshops/avd-extended-workshop-part-1}/avd-extended-workshop-part-1.md (100%) rename docs/avd/{extended-workshop.md => workshops/avd-extended-workshop/avd-extended-workshop.md} (100%) delete mode 100644 docs/cvaas/avd-evpn-aa.md rename docs/cvaas/{avd-cvaas-evpn-aa.md => demos/avd-evpn-active-active/avd-evpn-active-active.md} (100%) rename docs/cvaas/{ => demos/avd-evpn-mlag}/avd-evpn-mlag.md (100%) diff --git a/docs/assets/images/account_settings.png b/docs/assets/img/account_settings.png similarity index 100% rename from docs/assets/images/account_settings.png rename to docs/assets/img/account_settings.png diff --git a/docs/assets/images/codespaces-secrets.png b/docs/assets/img/codespaces-secrets.png similarity index 100% rename from docs/assets/images/codespaces-secrets.png rename to docs/assets/img/codespaces-secrets.png diff --git a/docs/stylesheets/extra.css b/docs/assets/stylesheets/extra.css similarity index 100% rename from docs/stylesheets/extra.css rename to docs/assets/stylesheets/extra.css diff --git a/docs/avd/avd-extended-workshop-part-1.md b/docs/avd/workshops/avd-extended-workshop-part-1/avd-extended-workshop-part-1.md similarity index 100% rename from docs/avd/avd-extended-workshop-part-1.md rename to docs/avd/workshops/avd-extended-workshop-part-1/avd-extended-workshop-part-1.md diff --git a/docs/avd/extended-workshop.md b/docs/avd/workshops/avd-extended-workshop/avd-extended-workshop.md similarity index 100% rename from docs/avd/extended-workshop.md rename to docs/avd/workshops/avd-extended-workshop/avd-extended-workshop.md diff --git a/docs/cvaas/avd-evpn-aa.md b/docs/cvaas/avd-evpn-aa.md deleted file mode 100644 index c48e03b..0000000 --- a/docs/cvaas/avd-evpn-aa.md +++ /dev/null @@ -1,49 +0,0 @@ -# AVD CVaaS EVPN Active-Active Demo - -## Demo Details - -!!! Success "Container Requirements" - - CPUs: 4 - Memory: 16 GB - Storage: 32 GB - - :material-checkbox-marked-outline: Works with default Codespaces sizing! - -[Start The EVPN AA Demo](https://codespaces.new/arista-netdevops-community/one-click-se-demos?quickstart=1&devcontainer_path=.devcontainer%2Favd_cvaas_evpn_aa%2Fdevcontainer.json){ .md-button .md-button--primary target=_blank} - -[Slides](https://arista-netdevops-community.github.io/one-click-se-demos/slides/avd_cvaas.html){ target=_blank } -[PDF Slides](https://arista-netdevops-community.github.io/one-click-se-demos/pdfs/avd_cvaas.pdf){ target=_blank } - -!!! Info "Last reviewed: 05.2024" - - Demos and labs review over 6 month age may be outdated. - -## How To Run The Demo - -???+ Tip "Wait until cEOS-lab image will be imported" - - You can confirm if image was imported correctly with `docker image ls` - -```bash -# 1. start cLab -make start -``` - -???+ Tip "Wait until all devices will start streaming to CVaaS." - - This may take a while. - -```bash -# 2. build configs with AVD -make build -# 3. create CVP change control (1) -make deploy_cvp -# 4. assign tags for CVP topology view (2) -make tags -# 5. validate the deployment with ANTA preview -make test -``` - -1. !!! Tip "Review and execute the change control on CVP when all tasks will be created." -2. !!! Bug "Currently there is a bug with disabling LLDP on Ma0, which prevents topology view from functioning correctly." diff --git a/docs/cvaas/avd-cvaas-evpn-aa.md b/docs/cvaas/demos/avd-evpn-active-active/avd-evpn-active-active.md similarity index 100% rename from docs/cvaas/avd-cvaas-evpn-aa.md rename to docs/cvaas/demos/avd-evpn-active-active/avd-evpn-active-active.md diff --git a/docs/cvaas/avd-evpn-mlag.md b/docs/cvaas/demos/avd-evpn-mlag/avd-evpn-mlag.md similarity index 100% rename from docs/cvaas/avd-evpn-mlag.md rename to docs/cvaas/demos/avd-evpn-mlag/avd-evpn-mlag.md diff --git a/docs/index.md b/docs/index.md index 7c44d81..d5496a2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -32,14 +32,14 @@ To set the token: ??? "Step1: Go to the Account Settings (right top corner)" - ![account settings](assets/images/account_settings.png){ .opacity09 } + ![account settings](assets/img/account_settings.png){ .opacity09 } ???+ "Step2: Go to `Codespaces > Codespaces secrets > New secret`" - add ARTOKEN to auto-download EOS images from [arista.com](arista.com). Under `Repository access` select `arista-netdevops-community/one-click-se-demos` - add CV_API_TOKEN if CVaaS is part of the demo. Keep in mind, this token has to be created under service account. Device onboarding token is not required as it will be generated automatically. Under `Repository access` select `arista-netdevops-community/one-click-se-demos` - ![codespaces secrets](assets/images/codespaces-secrets.png){ .opacity09 } + ![codespaces secrets](assets/img/codespaces-secrets.png){ .opacity09 } !!! Warning "WARNING!" diff --git a/mkdocs.yml b/mkdocs.yml index dd0e8c8..7a9c32f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,7 +5,7 @@ repo_name: SE Demos on Github repo_url: https://github.com/arista-netdevops-community/one-click-se-demos extra_css: - - stylesheets/extra.css + - assets/stylesheets/extra.css theme: name: material @@ -24,7 +24,7 @@ theme: # - navigation.instant.prefetch # - navigation.instant.progress # - navigation.prune - - navigation.sections + # - navigation.sections - navigation.tabs # enabling prune for testing only, to check if it's stable # it's not making any difference with current site setup @@ -81,12 +81,14 @@ nav: - Home: - How To Start: index.md - Credits: credits.md - - CVaaS Demos: - - AVD EVPN MLAG: cvaas/avd-evpn-mlag.md - - AVD EVPN Active-Active: cvaas/avd-cvaas-evpn-aa.md - - AVD Demos: - - AVD Extended Workshop: avd/extended-workshop.md - - AVD Extended Workshop, Part 1: avd/avd-extended-workshop-part-1.md + - CVaaS: + - Demo: + - AVD EVPN MLAG: cvaas/demos/avd-evpn-mlag/avd-evpn-mlag.md + - AVD EVPN Active-Active: cvaas/demos/avd-evpn-active-active/avd-evpn-active-active.md + - AVD: + - Workshops: + - AVD Extended Workshop: avd/workshops/avd-extended-workshop/avd-extended-workshop.md + - AVD Extended Workshop, Part 1: avd/workshops/avd-extended-workshop-part-1/avd-extended-workshop-part-1.md copyright: >  🍪 Change cookie settings