#157: Added link checker for the documentation (#158)

exasol · Jan 31, 2024 · 71c8db1 · 71c8db1
1 parent 13b6fb5
commit 71c8db1
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 3 deletions.
diff --git a/.github/workflows/check_documentation_links.yaml b/.github/workflows/check_documentation_links.yaml
@@ -0,0 +1,23 @@
+name: Check Documentation Links
+
+on:
+  push:
+    branches-ignore:
+      - "main"
+
+jobs:
+  check_documentation_links:
+    runs-on: ubuntu-latest
+
+    steps:
+     - uses: actions/checkout@v3
+       with:
+         fetch-depth: 0
+
+     - name: Link Checker
+       id: lychee
+       uses: lycheeverse/[email protected]
+       with:
+         fail: true
+         args: --verbose --no-progress 'doc/**/*.md' 'README.md'
+
diff --git a/doc/changes/changes_0.1.0.md b/doc/changes/changes_0.1.0.md
@@ -35,6 +35,7 @@ Version: 0.1.0
 * #145: Added Docker Test Library to prepare Notebook tests
 * #151: Setup SageMaker Credentials for notebook testing in the CI
 * #155: Added a Notebook Link Checker to Github Actions
+* #157: Added link checker for the documentation
 
 ## Bug Fixes
 

diff --git a/doc/developer_guide/notebooks.md b/doc/developer_guide/notebooks.md
@@ -7,12 +7,12 @@ Please add or update the notebook files in folder [exasol/ds/sandbox/runtime/ans
 ## Notebook Testing
 
 We are running tests for the notebooks in the Docker Edition of the AI Lab. For this we are creating a Docker test setup in 
-[test_notebooks_in_dss_docker_image.py](test/integration/test_notebooks_in_dss_docker_image.py) which installs test libraries into the AI Lab Docker Image.
-It further creates a new test and Docker Container for each notebook test in [test/notebooks](test/notebooks). 
+[test_notebooks_in_dss_docker_image.py](../../test/notebook_test_runner/test_notebooks_in_dss_docker_image.py) which installs test libraries into the AI Lab Docker Image.
+It further creates a new test and Docker Container for each notebook test in [test/notebooks](../../test/notebooks). 
 Notebook test names need to fit the pattern `nbtest_*.py`, to prevent pytest running them outside of Docker setup.
 
 Environment variables with the prefix `NBTEST_` with which you call
-[test_notebooks_in_dss_docker_image.py](test/integration/test_notebooks_in_dss_docker_image.py) are forwarded 
+[test_notebooks_in_dss_docker_image.py](../../test/notebook_test_runner/test_notebooks_in_dss_docker_image.py) are forwarded 
 into the Docker container and to the notebook test. You can use this to forward secrets to the notebook tests.
 
 By default all created containers and images are removed after running the tests regardless of success or failure.