From 7c5eccbf14c8791bb90f947bfb7ca9ffaaaf5ff5 Mon Sep 17 00:00:00 2001
From: Karel van Klink <karel.vanklink@geant.org>
Date: Fri, 25 Aug 2023 11:35:58 +0200
Subject: [PATCH] update image paths, update gitignore and gitlab-ci

Signed-off-by: Karel van Klink <karel.vanklink@geant.org>
---
 .gitignore                               |  2 +-
 .gitlab-ci.yml                           | 26 ++++++++----------------
 docs/architecture/modeling/ports.md      |  4 ++--
 docs/legacy_platform/overview.md         |  2 +-
 docs/user_guide/routers/deploy_router.md |  2 +-
 5 files changed, 14 insertions(+), 22 deletions(-)

diff --git a/.gitignore b/.gitignore
index 53285fe..5995075 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,4 +8,4 @@ venv/
 docs/build
 vale/styles/*
 !vale/styles/Vocab/
-site/
+public/
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 360dd89..57e6cd9 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -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/
diff --git a/docs/architecture/modeling/ports.md b/docs/architecture/modeling/ports.md
index ec0f412..6be81fe 100644
--- a/docs/architecture/modeling/ports.md
+++ b/docs/architecture/modeling/ports.md
@@ -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.*
diff --git a/docs/legacy_platform/overview.md b/docs/legacy_platform/overview.md
index 5e1d825..8f50903 100644
--- a/docs/legacy_platform/overview.md
+++ b/docs/legacy_platform/overview.md
@@ -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
diff --git a/docs/user_guide/routers/deploy_router.md b/docs/user_guide/routers/deploy_router.md
index 1fa94eb..7bde970 100644
--- a/docs/user_guide/routers/deploy_router.md
+++ b/docs/user_guide/routers/deploy_router.md
@@ -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.*
-- 
GitLab