Move documentation related files into subdirectory to clean up root dir of project

.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

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).

build-docs.sh → 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

docs/includes/glossary.md

+*[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

mkdocs.yml → 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:

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",