Skip to content
Snippets Groups Projects
Verified Commit 7c5eccbf authored by Karel van Klink's avatar Karel van Klink :smiley_cat:
Browse files

update image paths, update gitignore and gitlab-ci

parent fa6ddcaa
No related branches found
No related tags found
2 merge requests!12Move to MkDocs material,!11Move to MkDocs material
Pipeline #83924 passed
......@@ -8,4 +8,4 @@ venv/
docs/build
vale/styles/*
!vale/styles/Vocab/
site/
public/
......@@ -12,30 +12,22 @@ stages:
# artifacts:
# paths:
# - public
# rules:
# - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
##### Sphinx - Generate documentation
build-documentation:
stage: documentation
tags:
- docker-executor
image: sphinxdoc/sphinx:latest
# Only run this pipeline if the committed changes are somewhere within the docs subdirectory
only:
changes:
- docs/**/*
image: python:latest
before_script:
- cd $CI_PROJECT_DIR/docs
- pip install sphinx_rtd_theme myst-parser
- pip install mkdocs-material
script:
- make html
- mkdocs build --site-dir public
artifacts:
paths:
- docs/build/html
- public
##### Vale - Documentation linter
lint-documentation:
......@@ -51,11 +43,11 @@ lint-documentation:
artifacts: true
before_script:
- cd $CI_PROJECT_DIR/docs/vale
- cd $CI_PROJECT_DIR/vale
- vale sync
script:
- vale $CI_PROJECT_DIR/docs/build/html/_sources
- vale $CI_PROJECT_DIR/docs/
##### Publish documentation artefacts
publish-prod-2:
......@@ -72,8 +64,8 @@ publish-prod-2:
artifacts: true
script:
- rm -r /var/www/gap-docs/*
- mv $CI_PROJECT_DIR/docs/build/html/* /var/www/gap-docs/
- rm -rf /var/www/gap-docs/*
- mv $CI_PROJECT_DIR/public/* /var/www/gap-docs/
publish-prod-1:
stage: publish-prod-1
......@@ -90,5 +82,5 @@ publish-prod-1:
artifacts: true
script:
- rm -r /var/www/gap-docs/*
- rm -rf /var/www/gap-docs/*
- mv $CI_PROJECT_DIR/docs/build/html/* /var/www/gap-docs/
......@@ -17,7 +17,7 @@ GAN
These concepts apply to both CFSes and IFSes.
![GÉANT service entities](/assets/images/access_port_diagram.png)
![GÉANT service entities](../../assets/images/access_port_diagram.png)
*A visualisation of how services insist on ports.*
......@@ -29,6 +29,6 @@ However, for multipoint services customers are supposed to be dual-homed in at l
To give some examples, the figure below shows a decomposition of a GeantIP service for an NREN.
![GeantIP service entities](/assets/images/geant_ip_ports_diagram.png)
![GeantIP service entities](../../assets/images/geant_ip_ports_diagram.png)
*A visualisation of an instance of a GeantIP service that consists of different configuration objects.*
......@@ -12,7 +12,7 @@ playbooks</a> stored in Git
An overview of the platform is depicted in the following picture:
![GAP_overview](/assets/images/Legacy_GAP_diagrams.overview.drawio.png)
![GAP_overview](../assets/images/Legacy_GAP_diagrams.overview.drawio.png)
## Functionalities
......
......@@ -9,6 +9,6 @@ From a bird's-eye view, the process of deploying a new router in the network is
5. Update the protocol meshes (such as iBGP).
6. Promote the router to the production environment.
![Provisioning a router in WFO](/assets/images/WFO_deploy_router.png)
![Provisioning a router in WFO](../../assets/images/WFO_deploy_router.png)
*WFO provisions a new router by following the steps shown here.*
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment