diff --git a/docs/admin_guide/index.md b/docs/admin_guide/index.md index c7774424d6b8ade323472145da4352ab01f0c7fc..de3d3b219efa38e08a4c78234fe6dbe73ee8a572 100644 --- a/docs/admin_guide/index.md +++ b/docs/admin_guide/index.md @@ -1,14 +1,14 @@ # About this section -All the information regarding modeling, workflows and ansible mechanics are described in this section. -Next to this, also troubleshoting and maintainance are included. +All the information regarding modeling, workflows and Ansible mechanics are described in this section. +Next to this, also troubleshooting and maintenance are included. The structure is: - WFO - Modelling - Workflow - - Maintainance + - Maintenance - Troubleshoot - Ansible - Design diff --git a/docs/legacy_platform/overview.md b/docs/legacy_platform/overview.md index a5310cde55d58f3d1c80aa82f2b8af28beea2732..cce2b9f0c5b111c499a92cb0f80fce4d3c6f5601 100644 --- a/docs/legacy_platform/overview.md +++ b/docs/legacy_platform/overview.md @@ -1,9 +1,9 @@ # Overview -Current GAP is extremely simple and its foundamental parts are: +The current {term}`GAP` is simple and its fundamental parts are: -- An ansible inventory stored in Git [Ansible inventory](https://gitlab.geant.net/neteam/network-automation/na-production/prod_network_inventory/-/tree/master) -- A set of ansible playbooks stored in Git [Ansible playbooks](https://gitlab.geant.net/neteam/network-automation/na-production/prod_network_ansible) +- An [Ansible inventory](https://gitlab.geant.net/neteam/network-automation/na-production/prod_network_inventory/-/tree/master) stored in Git +- A set of [Ansible playbooks](https://gitlab.geant.net/neteam/network-automation/na-production/prod_network_ansible) stored in Git - An Ansible master instance to execute these playbooks - A Jenkins instance to orchestrate Ansible @@ -14,10 +14,10 @@ An overview of the platform is depicted in the following picture: ## Functionalities -Currently GAP is capable of the following capabilities: +Currently, {term}`GAP` is capable of the following capabilities: -- Provisioning of nodes and IPtrunks: - - Deployment of base config on a new router +- Provisioning of nodes and {term}`IP` trunks: + - Deployment of base configuration on a new router - Deployment of a new trunk with metric=9000 - Insertion of a new router in the iBGP mesh - Periodic checks of configuration: diff --git a/docs/static/Image_sources/.$Legacy_GAP_diagrams.drawio.bkp b/docs/static/image_sources/.$Legacy_GAP_diagrams.drawio.bkp similarity index 100% rename from docs/static/Image_sources/.$Legacy_GAP_diagrams.drawio.bkp rename to docs/static/image_sources/.$Legacy_GAP_diagrams.drawio.bkp diff --git a/docs/static/Image_sources/Legacy_GAP_diagrams.drawio b/docs/static/image_sources/Legacy_GAP_diagrams.drawio similarity index 100% rename from docs/static/Image_sources/Legacy_GAP_diagrams.drawio rename to docs/static/image_sources/Legacy_GAP_diagrams.drawio diff --git a/docs/user_guide/Routers/routers.md b/docs/user_guide/Routers/routers.md index f59535222939873c8048c66e2670ee70832069de..55e99ea2dd13c7abf6fa96c7495a473dc65a7045 100644 --- a/docs/user_guide/Routers/routers.md +++ b/docs/user_guide/Routers/routers.md @@ -2,4 +2,4 @@ ## Deployment -## Undeployment +## Termination diff --git a/docs/vale/.vale.ini b/docs/vale/.vale.ini index 3abe670e22315ca4b13a17c3702bf9d2fc9b4d84..c6972601061c2c53893c7e718902cec048e17f10 100644 --- a/docs/vale/.vale.ini +++ b/docs/vale/.vale.ini @@ -12,5 +12,14 @@ txt = md [*] BasedOnStyles = Vale, proselint, Microsoft +; Found to be too intrusive +Microsoft.Passive = NO +; We are not a general audience +Microsoft.GeneralURL = NO +; Replacing a ... with … shouldn't be holding back the entire CI pipeline +proselint.Typography = warning +; Same applies for not using contractions +Microsoft.Contractions = warning + ; Ignore the table of contents directive BlockIgnores = (?s) *(\x60\x60\x60{toctree}.*?\x60\x60\x60) diff --git a/docs/vale/styles/Vocab/geant-jargon/accept.txt b/docs/vale/styles/Vocab/geant-jargon/accept.txt index 670f8943917139acd79785c8ad0967492b8d19da..6ea9aa937a879c5d42ebb57a3b8be7f5beabadf8 100644 --- a/docs/vale/styles/Vocab/geant-jargon/accept.txt +++ b/docs/vale/styles/Vocab/geant-jargon/accept.txt @@ -20,3 +20,4 @@ FXP NREN MTU OOB +Junos