diff --git a/.gitignore b/.gitignore index b803f4928c2c05654dc534d0a48ff70d9fbe15b7..fcfacde53b94401ea65e66f7390c2dc9da6c4040 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 b4563b2f937cd4cd5f7918a61fc3251c84aeb7be..75cbf42745d08cf5a24ca94b142b0a53dd74b679 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 f9ffac0ca7100469d6791fe520056abcff1b50f3..6bc432203847cc854773e8d6d80ab65eca9e1644 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 0000000000000000000000000000000000000000..20557ed522b1a24aca286bfaa1a6cd786b96dfa0 --- /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 c6808360a62ca9bed8c3ce6ac78da20a79d5fcd2..a59ca444c0858d655634b70f1e5ce72f6534c555 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 9e48581ccee60f54b2b085ac9b4255765af615c2..f9a03e60ec44b48b70db39c02cb80bed76cee586 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 d6c1fc37dbe38efe8974a2015175b66a4a99e8dd..7f53acba3a6d6229d0dbe743fc907b0c1d4f00a9 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