From 68922b65f7536a4ede46f154c62ce1eec007f887 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Fri, 29 Nov 2024 10:58:35 +0100
Subject: [PATCH] Move documentation related files into subdirectory to clean
up root dir of project
---
.gitignore | 11 ++---
README.md | 2 +-
build-docs.sh => docs/build-docs.sh | 5 ++-
docs/includes/glossary.md | 40 ++++++++++++++++++
mkdocs.yml => docs/mkdocs.yml | 3 +-
docs/scripts/gen_wf_redirects.py | 2 +-
.../admin_guide/ansible/ansible.md | 0
docs/{ => source}/admin_guide/index.md | 0
docs/{ => source}/admin_guide/oss_bss/ipam.md | 0
.../admin_guide/oss_bss/kentik.md | 0
.../admin_guide/oss_bss/librenms.md | 0
.../admin_guide/oss_bss/netbox.md | 0
docs/{ => source}/admin_guide/wfo/iptrunks.md | 0
docs/{ => source}/admin_guide/wfo/overview.md | 0
docs/{ => source}/admin_guide/wfo/routers.md | 0
docs/{ => source}/admin_guide/wfo/sites.md | 0
.../architecture/components/ansible/index.md | 0
.../architecture/components/index.md | 0
.../architecture/components/lso/index.md | 0
.../architecture/components/netbox/index.md | 0
.../architecture/components/wfo/index.md | 0
.../config_decomposition/index.md | 0
.../architecture/dtap/acceptance.md | 0
.../architecture/dtap/development.md | 0
docs/{ => source}/architecture/dtap/index.md | 0
.../architecture/dtap/production.md | 0
docs/{ => source}/architecture/dtap/test.md | 0
docs/{ => source}/architecture/index.md | 2 +-
...Architecture-WFO_Geant_specific.drawio.png | Bin
.../Legacy_GAP_diagrams.overview.drawio.png | Bin
.../TNC23_diagrams-AutomationTeam.drawio.png | Bin
.../TNC23_diagrams-ConfigSlicing.drawio.png | Bin
...TNC23_diagrams-Current platform.drawio.png | Bin
.../TNC23_diagrams-Separate Teams.drawio.png | Bin
...NC23_diagrams-Service_stitching.drawio.png | Bin
...23_diagrams-WFO-LSO_interaction.drawio.png | Bin
.../images/TNC23_diagrams-WFO_GAP.drawio.png | Bin
.../assets/images/WFO_deploy_router.png | Bin
.../assets/images/access_port_diagram.png | Bin
.../images/gap_architecture_diagram.png | Bin
.../assets/images/geant_ip_ports_diagram.png | Bin
.../assets/images/geant_logo_white.png | Bin
.../assets/images/geant_logo_white.svg | 0
.../images/image_sources/Architecture.drawio | 0
.../image_sources/Legacy_GAP_diagrams.drawio | 0
.../images/image_sources/tnc_diags.drawio | 0
docs/{ => source}/assets/images/logo.png | Bin
.../{ => source}/assets/stylesheets/extra.css | 0
docs/{ => source}/index.md | 0
test-docs.sh => docs/test-docs.sh | 0
{vale => docs/vale}/.vale.ini | 0
.../vocabularies/geant-jargon/accept.txt | 0
.../vale}/styles/custom/Contractions.yml | 0
53 files changed, 54 insertions(+), 11 deletions(-)
rename build-docs.sh => docs/build-docs.sh (56%)
create mode 100644 docs/includes/glossary.md
rename mkdocs.yml => docs/mkdocs.yml (98%)
rename docs/{ => source}/admin_guide/ansible/ansible.md (100%)
rename docs/{ => source}/admin_guide/index.md (100%)
rename docs/{ => source}/admin_guide/oss_bss/ipam.md (100%)
rename docs/{ => source}/admin_guide/oss_bss/kentik.md (100%)
rename docs/{ => source}/admin_guide/oss_bss/librenms.md (100%)
rename docs/{ => source}/admin_guide/oss_bss/netbox.md (100%)
rename docs/{ => source}/admin_guide/wfo/iptrunks.md (100%)
rename docs/{ => source}/admin_guide/wfo/overview.md (100%)
rename docs/{ => source}/admin_guide/wfo/routers.md (100%)
rename docs/{ => source}/admin_guide/wfo/sites.md (100%)
rename docs/{ => source}/architecture/components/ansible/index.md (100%)
rename docs/{ => source}/architecture/components/index.md (100%)
rename docs/{ => source}/architecture/components/lso/index.md (100%)
rename docs/{ => source}/architecture/components/netbox/index.md (100%)
rename docs/{ => source}/architecture/components/wfo/index.md (100%)
rename docs/{ => source}/architecture/config_decomposition/index.md (100%)
rename docs/{ => source}/architecture/dtap/acceptance.md (100%)
rename docs/{ => source}/architecture/dtap/development.md (100%)
rename docs/{ => source}/architecture/dtap/index.md (100%)
rename docs/{ => source}/architecture/dtap/production.md (100%)
rename docs/{ => source}/architecture/dtap/test.md (100%)
rename docs/{ => source}/architecture/index.md (98%)
rename docs/{ => source}/assets/images/Architecture-WFO_Geant_specific.drawio.png (100%)
rename docs/{ => source}/assets/images/Legacy_GAP_diagrams.overview.drawio.png (100%)
rename docs/{ => source}/assets/images/TNC23_diagrams-AutomationTeam.drawio.png (100%)
rename docs/{ => source}/assets/images/TNC23_diagrams-ConfigSlicing.drawio.png (100%)
rename docs/{ => source}/assets/images/TNC23_diagrams-Current platform.drawio.png (100%)
rename docs/{ => source}/assets/images/TNC23_diagrams-Separate Teams.drawio.png (100%)
rename docs/{ => source}/assets/images/TNC23_diagrams-Service_stitching.drawio.png (100%)
rename docs/{ => source}/assets/images/TNC23_diagrams-WFO-LSO_interaction.drawio.png (100%)
rename docs/{ => source}/assets/images/TNC23_diagrams-WFO_GAP.drawio.png (100%)
rename docs/{ => source}/assets/images/WFO_deploy_router.png (100%)
rename docs/{ => source}/assets/images/access_port_diagram.png (100%)
rename docs/{ => source}/assets/images/gap_architecture_diagram.png (100%)
rename docs/{ => source}/assets/images/geant_ip_ports_diagram.png (100%)
rename docs/{ => source}/assets/images/geant_logo_white.png (100%)
rename docs/{ => source}/assets/images/geant_logo_white.svg (100%)
rename docs/{ => source}/assets/images/image_sources/Architecture.drawio (100%)
rename docs/{ => source}/assets/images/image_sources/Legacy_GAP_diagrams.drawio (100%)
rename docs/{ => source}/assets/images/image_sources/tnc_diags.drawio (100%)
rename docs/{ => source}/assets/images/logo.png (100%)
rename docs/{ => source}/assets/stylesheets/extra.css (100%)
rename docs/{ => source}/index.md (100%)
rename test-docs.sh => docs/test-docs.sh (100%)
rename {vale => docs/vale}/.vale.ini (100%)
rename {vale => docs/vale}/styles/config/vocabularies/geant-jargon/accept.txt (100%)
rename {vale => docs/vale}/styles/custom/Contractions.yml (100%)
diff --git a/.gitignore b/.gitignore
index b803f492..fcfacde5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -12,12 +12,13 @@ oss-params.json
build/
# Documentation
-site
-vale/styles/*
-!vale/styles/config/
-!vale/styles/custom/
+docs/site
+docs/public
+docs/vale/styles/*
+!docs/vale/styles/config/
+!docs/vale/styles/custom/
.DS_Store
-wf_redirects.yaml
+docs/wf_redirects.yaml
.idea
.venv
diff --git a/README.md b/README.md
index b4563b2f..75cbf427 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,4 @@
The GÉANT interpretation of [``orchestrator-core``](https://github.com/workfloworchestrator/orchestrator-core).
## Documentation
-You can build the documentation locally using [build-docs.sh](build-docs.sh).
+You can build the documentation locally using [build-docs.sh](docs/build-docs.sh).
diff --git a/build-docs.sh b/docs/build-docs.sh
similarity index 56%
rename from build-docs.sh
rename to docs/build-docs.sh
index f9ffac0c..6bc43220 100755
--- a/build-docs.sh
+++ b/docs/build-docs.sh
@@ -2,9 +2,10 @@
set -o errexit
set -o nounset
-export OSS_PARAMS_FILENAME=gso/oss-params-example.json
+export OSS_PARAMS_FILENAME=../gso/oss-params-example.json
export TESTING=true
+python ./scripts/gen_wf_redirects.py
pip install mkdocstrings-python mkdocs_gen_files mkdocs-material mkdocs-literate-nav mkdocs-redirects
-mkdocs build
+mkdocs build --site-dir public
diff --git a/docs/includes/glossary.md b/docs/includes/glossary.md
new file mode 100644
index 00000000..20557ed5
--- /dev/null
+++ b/docs/includes/glossary.md
@@ -0,0 +1,40 @@
+*[AAA]: Authentication, Authorisation, Accounting
+*[BGP]: Border Gateway Protocol
+*[BSS]: Business Support Systems
+*[CFS]: Customer Facing Service
+*[DCIM]: Datacenter Infrastructure Manager
+*[DHCP]: Dynamic Host Configuration Protocol
+*[DNS]: Domain Name System
+*[DTAP]: Development, Testing, Acceptance, and Production
+*[eBGP]: External BGP
+*[FQDN]: Fully Quantified Domain Name
+*[GA]: Access Port
+*[GAN]: Access Node
+*[GAP]: GÉANT Automation Platform
+*[GOAT]: GÉANT Orchestration and Automation Team
+*[GP]: Physical Port
+*[GSO]: GÉANT Service Orchestrator
+*[GUI]: Graphical User Interface
+*[iBGP]: Internal BGP
+*[IGP]: Internal Gateway Protocol
+*[IFS]: Interface Facing Service
+*[IPAM]: IP Address Management
+*[IS-IS]: Intermediate System to Intermediate System
+*[L3VPN]: Layer 3 VPN
+*[LSO]: Lightweight Service Orchestrator
+*[MPLS]: Multi-Protocol Label Switching
+*[MTTR]: Mean Time To Repair
+*[MTU]: Maximum Transmission Unit
+*[NREN]: National Research and Education Network
+*[OOB]: Out-of-band
+*[OSS]: Operational Support Systems
+*[PoP]: Point of Presence
+*[REST]: Representational State Transfer
+*[RFC]: Request For Comments
+*[SDP]: Service Delivery Point
+*[SNMP]: Simple Network Management Protocol
+*[SOT]: Source Of Truth
+*[TBA]: To be added
+*[UAT]: User Acceptance Testing
+*[VM]: Virtual Machine
+*[WFO]: Workflow Orchestrator
diff --git a/mkdocs.yml b/docs/mkdocs.yml
similarity index 98%
rename from mkdocs.yml
rename to docs/mkdocs.yml
index c6808360..a59ca444 100644
--- a/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -4,6 +4,7 @@ site_name: GÉANT Automation Platform
site_url: https://docs.gap.geant.org/
site_author: GÉANT Orchestration and Automation Team
site_description: Documentation of the GÉANT Automation Platform and the GÉANT Service Orchestrator
+docs_dir: source
# Repositories
repo_name: geant-service-orchestrator
@@ -14,7 +15,7 @@ theme:
name: material
logo_light_mode: assets/images/logo.png
logo_dark_mode: assets/images/geant_logo_white.png
- custom_dir: docs/overrides
+ custom_dir: overrides
icon:
repo: fontawesome/brands/gitlab
features:
diff --git a/docs/scripts/gen_wf_redirects.py b/docs/scripts/gen_wf_redirects.py
index 9e48581c..f9a03e60 100644
--- a/docs/scripts/gen_wf_redirects.py
+++ b/docs/scripts/gen_wf_redirects.py
@@ -29,7 +29,7 @@ with open(root / "wf_redirects.yaml", 'w') as redirect_file:
"plugins":
[
"search",
- {"gen-files": {"scripts": ["docs/scripts/gen_ref_pages.py"]}},
+ {"gen-files": {"scripts": ["scripts/gen_ref_pages.py"]}},
{"redirects": {"redirect_maps": redirect_map}},
{"literate-nav": {"nav_file": "SUMMARY.md"}},
"mkdocstrings",
diff --git a/docs/admin_guide/ansible/ansible.md b/docs/source/admin_guide/ansible/ansible.md
similarity index 100%
rename from docs/admin_guide/ansible/ansible.md
rename to docs/source/admin_guide/ansible/ansible.md
diff --git a/docs/admin_guide/index.md b/docs/source/admin_guide/index.md
similarity index 100%
rename from docs/admin_guide/index.md
rename to docs/source/admin_guide/index.md
diff --git a/docs/admin_guide/oss_bss/ipam.md b/docs/source/admin_guide/oss_bss/ipam.md
similarity index 100%
rename from docs/admin_guide/oss_bss/ipam.md
rename to docs/source/admin_guide/oss_bss/ipam.md
diff --git a/docs/admin_guide/oss_bss/kentik.md b/docs/source/admin_guide/oss_bss/kentik.md
similarity index 100%
rename from docs/admin_guide/oss_bss/kentik.md
rename to docs/source/admin_guide/oss_bss/kentik.md
diff --git a/docs/admin_guide/oss_bss/librenms.md b/docs/source/admin_guide/oss_bss/librenms.md
similarity index 100%
rename from docs/admin_guide/oss_bss/librenms.md
rename to docs/source/admin_guide/oss_bss/librenms.md
diff --git a/docs/admin_guide/oss_bss/netbox.md b/docs/source/admin_guide/oss_bss/netbox.md
similarity index 100%
rename from docs/admin_guide/oss_bss/netbox.md
rename to docs/source/admin_guide/oss_bss/netbox.md
diff --git a/docs/admin_guide/wfo/iptrunks.md b/docs/source/admin_guide/wfo/iptrunks.md
similarity index 100%
rename from docs/admin_guide/wfo/iptrunks.md
rename to docs/source/admin_guide/wfo/iptrunks.md
diff --git a/docs/admin_guide/wfo/overview.md b/docs/source/admin_guide/wfo/overview.md
similarity index 100%
rename from docs/admin_guide/wfo/overview.md
rename to docs/source/admin_guide/wfo/overview.md
diff --git a/docs/admin_guide/wfo/routers.md b/docs/source/admin_guide/wfo/routers.md
similarity index 100%
rename from docs/admin_guide/wfo/routers.md
rename to docs/source/admin_guide/wfo/routers.md
diff --git a/docs/admin_guide/wfo/sites.md b/docs/source/admin_guide/wfo/sites.md
similarity index 100%
rename from docs/admin_guide/wfo/sites.md
rename to docs/source/admin_guide/wfo/sites.md
diff --git a/docs/architecture/components/ansible/index.md b/docs/source/architecture/components/ansible/index.md
similarity index 100%
rename from docs/architecture/components/ansible/index.md
rename to docs/source/architecture/components/ansible/index.md
diff --git a/docs/architecture/components/index.md b/docs/source/architecture/components/index.md
similarity index 100%
rename from docs/architecture/components/index.md
rename to docs/source/architecture/components/index.md
diff --git a/docs/architecture/components/lso/index.md b/docs/source/architecture/components/lso/index.md
similarity index 100%
rename from docs/architecture/components/lso/index.md
rename to docs/source/architecture/components/lso/index.md
diff --git a/docs/architecture/components/netbox/index.md b/docs/source/architecture/components/netbox/index.md
similarity index 100%
rename from docs/architecture/components/netbox/index.md
rename to docs/source/architecture/components/netbox/index.md
diff --git a/docs/architecture/components/wfo/index.md b/docs/source/architecture/components/wfo/index.md
similarity index 100%
rename from docs/architecture/components/wfo/index.md
rename to docs/source/architecture/components/wfo/index.md
diff --git a/docs/architecture/config_decomposition/index.md b/docs/source/architecture/config_decomposition/index.md
similarity index 100%
rename from docs/architecture/config_decomposition/index.md
rename to docs/source/architecture/config_decomposition/index.md
diff --git a/docs/architecture/dtap/acceptance.md b/docs/source/architecture/dtap/acceptance.md
similarity index 100%
rename from docs/architecture/dtap/acceptance.md
rename to docs/source/architecture/dtap/acceptance.md
diff --git a/docs/architecture/dtap/development.md b/docs/source/architecture/dtap/development.md
similarity index 100%
rename from docs/architecture/dtap/development.md
rename to docs/source/architecture/dtap/development.md
diff --git a/docs/architecture/dtap/index.md b/docs/source/architecture/dtap/index.md
similarity index 100%
rename from docs/architecture/dtap/index.md
rename to docs/source/architecture/dtap/index.md
diff --git a/docs/architecture/dtap/production.md b/docs/source/architecture/dtap/production.md
similarity index 100%
rename from docs/architecture/dtap/production.md
rename to docs/source/architecture/dtap/production.md
diff --git a/docs/architecture/dtap/test.md b/docs/source/architecture/dtap/test.md
similarity index 100%
rename from docs/architecture/dtap/test.md
rename to docs/source/architecture/dtap/test.md
diff --git a/docs/architecture/index.md b/docs/source/architecture/index.md
similarity index 98%
rename from docs/architecture/index.md
rename to docs/source/architecture/index.md
index d6c1fc37..7f53acba 100644
--- a/docs/architecture/index.md
+++ b/docs/source/architecture/index.md
@@ -17,7 +17,7 @@ with that particular system will take care of allocating and configuring the nec
Included in the orchestration layer there is a service database that stores all instances of the services in accordance
to their respective domain models. More details are available in the section
-[GAP components](./components/index.md)
+[GAP components](components/index.md)
## OSS/BSS systems currently in scope
diff --git a/docs/assets/images/Architecture-WFO_Geant_specific.drawio.png b/docs/source/assets/images/Architecture-WFO_Geant_specific.drawio.png
similarity index 100%
rename from docs/assets/images/Architecture-WFO_Geant_specific.drawio.png
rename to docs/source/assets/images/Architecture-WFO_Geant_specific.drawio.png
diff --git a/docs/assets/images/Legacy_GAP_diagrams.overview.drawio.png b/docs/source/assets/images/Legacy_GAP_diagrams.overview.drawio.png
similarity index 100%
rename from docs/assets/images/Legacy_GAP_diagrams.overview.drawio.png
rename to docs/source/assets/images/Legacy_GAP_diagrams.overview.drawio.png
diff --git a/docs/assets/images/TNC23_diagrams-AutomationTeam.drawio.png b/docs/source/assets/images/TNC23_diagrams-AutomationTeam.drawio.png
similarity index 100%
rename from docs/assets/images/TNC23_diagrams-AutomationTeam.drawio.png
rename to docs/source/assets/images/TNC23_diagrams-AutomationTeam.drawio.png
diff --git a/docs/assets/images/TNC23_diagrams-ConfigSlicing.drawio.png b/docs/source/assets/images/TNC23_diagrams-ConfigSlicing.drawio.png
similarity index 100%
rename from docs/assets/images/TNC23_diagrams-ConfigSlicing.drawio.png
rename to docs/source/assets/images/TNC23_diagrams-ConfigSlicing.drawio.png
diff --git a/docs/assets/images/TNC23_diagrams-Current platform.drawio.png b/docs/source/assets/images/TNC23_diagrams-Current platform.drawio.png
similarity index 100%
rename from docs/assets/images/TNC23_diagrams-Current platform.drawio.png
rename to docs/source/assets/images/TNC23_diagrams-Current platform.drawio.png
diff --git a/docs/assets/images/TNC23_diagrams-Separate Teams.drawio.png b/docs/source/assets/images/TNC23_diagrams-Separate Teams.drawio.png
similarity index 100%
rename from docs/assets/images/TNC23_diagrams-Separate Teams.drawio.png
rename to docs/source/assets/images/TNC23_diagrams-Separate Teams.drawio.png
diff --git a/docs/assets/images/TNC23_diagrams-Service_stitching.drawio.png b/docs/source/assets/images/TNC23_diagrams-Service_stitching.drawio.png
similarity index 100%
rename from docs/assets/images/TNC23_diagrams-Service_stitching.drawio.png
rename to docs/source/assets/images/TNC23_diagrams-Service_stitching.drawio.png
diff --git a/docs/assets/images/TNC23_diagrams-WFO-LSO_interaction.drawio.png b/docs/source/assets/images/TNC23_diagrams-WFO-LSO_interaction.drawio.png
similarity index 100%
rename from docs/assets/images/TNC23_diagrams-WFO-LSO_interaction.drawio.png
rename to docs/source/assets/images/TNC23_diagrams-WFO-LSO_interaction.drawio.png
diff --git a/docs/assets/images/TNC23_diagrams-WFO_GAP.drawio.png b/docs/source/assets/images/TNC23_diagrams-WFO_GAP.drawio.png
similarity index 100%
rename from docs/assets/images/TNC23_diagrams-WFO_GAP.drawio.png
rename to docs/source/assets/images/TNC23_diagrams-WFO_GAP.drawio.png
diff --git a/docs/assets/images/WFO_deploy_router.png b/docs/source/assets/images/WFO_deploy_router.png
similarity index 100%
rename from docs/assets/images/WFO_deploy_router.png
rename to docs/source/assets/images/WFO_deploy_router.png
diff --git a/docs/assets/images/access_port_diagram.png b/docs/source/assets/images/access_port_diagram.png
similarity index 100%
rename from docs/assets/images/access_port_diagram.png
rename to docs/source/assets/images/access_port_diagram.png
diff --git a/docs/assets/images/gap_architecture_diagram.png b/docs/source/assets/images/gap_architecture_diagram.png
similarity index 100%
rename from docs/assets/images/gap_architecture_diagram.png
rename to docs/source/assets/images/gap_architecture_diagram.png
diff --git a/docs/assets/images/geant_ip_ports_diagram.png b/docs/source/assets/images/geant_ip_ports_diagram.png
similarity index 100%
rename from docs/assets/images/geant_ip_ports_diagram.png
rename to docs/source/assets/images/geant_ip_ports_diagram.png
diff --git a/docs/assets/images/geant_logo_white.png b/docs/source/assets/images/geant_logo_white.png
similarity index 100%
rename from docs/assets/images/geant_logo_white.png
rename to docs/source/assets/images/geant_logo_white.png
diff --git a/docs/assets/images/geant_logo_white.svg b/docs/source/assets/images/geant_logo_white.svg
similarity index 100%
rename from docs/assets/images/geant_logo_white.svg
rename to docs/source/assets/images/geant_logo_white.svg
diff --git a/docs/assets/images/image_sources/Architecture.drawio b/docs/source/assets/images/image_sources/Architecture.drawio
similarity index 100%
rename from docs/assets/images/image_sources/Architecture.drawio
rename to docs/source/assets/images/image_sources/Architecture.drawio
diff --git a/docs/assets/images/image_sources/Legacy_GAP_diagrams.drawio b/docs/source/assets/images/image_sources/Legacy_GAP_diagrams.drawio
similarity index 100%
rename from docs/assets/images/image_sources/Legacy_GAP_diagrams.drawio
rename to docs/source/assets/images/image_sources/Legacy_GAP_diagrams.drawio
diff --git a/docs/assets/images/image_sources/tnc_diags.drawio b/docs/source/assets/images/image_sources/tnc_diags.drawio
similarity index 100%
rename from docs/assets/images/image_sources/tnc_diags.drawio
rename to docs/source/assets/images/image_sources/tnc_diags.drawio
diff --git a/docs/assets/images/logo.png b/docs/source/assets/images/logo.png
similarity index 100%
rename from docs/assets/images/logo.png
rename to docs/source/assets/images/logo.png
diff --git a/docs/assets/stylesheets/extra.css b/docs/source/assets/stylesheets/extra.css
similarity index 100%
rename from docs/assets/stylesheets/extra.css
rename to docs/source/assets/stylesheets/extra.css
diff --git a/docs/index.md b/docs/source/index.md
similarity index 100%
rename from docs/index.md
rename to docs/source/index.md
diff --git a/test-docs.sh b/docs/test-docs.sh
similarity index 100%
rename from test-docs.sh
rename to docs/test-docs.sh
diff --git a/vale/.vale.ini b/docs/vale/.vale.ini
similarity index 100%
rename from vale/.vale.ini
rename to docs/vale/.vale.ini
diff --git a/vale/styles/config/vocabularies/geant-jargon/accept.txt b/docs/vale/styles/config/vocabularies/geant-jargon/accept.txt
similarity index 100%
rename from vale/styles/config/vocabularies/geant-jargon/accept.txt
rename to docs/vale/styles/config/vocabularies/geant-jargon/accept.txt
diff --git a/vale/styles/custom/Contractions.yml b/docs/vale/styles/custom/Contractions.yml
similarity index 100%
rename from vale/styles/custom/Contractions.yml
rename to docs/vale/styles/custom/Contractions.yml
--
GitLab