From 4e11518921265e7ce3d144f57ce63d8e89e9c2b5 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Wed, 16 Aug 2023 11:06:30 +0200
Subject: [PATCH] resolve vale errors
Signed-off-by: Karel van Klink <karel.vanklink@geant.org>
---
docs/admin_guide/index.md | 6 +++---
docs/legacy_platform/overview.md | 12 ++++++------
.../.$Legacy_GAP_diagrams.drawio.bkp | 0
.../Legacy_GAP_diagrams.drawio | 0
docs/user_guide/Routers/routers.md | 2 +-
docs/vale/.vale.ini | 9 +++++++++
docs/vale/styles/Vocab/geant-jargon/accept.txt | 1 +
7 files changed, 20 insertions(+), 10 deletions(-)
rename docs/static/{Image_sources => image_sources}/.$Legacy_GAP_diagrams.drawio.bkp (100%)
rename docs/static/{Image_sources => image_sources}/Legacy_GAP_diagrams.drawio (100%)
diff --git a/docs/admin_guide/index.md b/docs/admin_guide/index.md
index c777442..de3d3b2 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 a5310cd..cce2b9f 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 f595352..55e99ea 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 3abe670..c697260 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 670f894..6ea9aa9 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
--
GitLab