From cd9e130f921ae5367548de88d7392d5e68574622 Mon Sep 17 00:00:00 2001
From: Lina Wolf <48202465+linawolf@users.noreply.github.com>
Date: Tue, 1 Oct 2024 19:20:19 +0200
Subject: [PATCH] [TASK] Add a testing workflow (#168)
And fix warnings
---
.github/workflows/test-documentation.yml | 17 +++++++++++++++++
Documentation/Exceptions/1257246929.rst | 2 +-
Documentation/Exceptions/1705656657.rst | 2 +-
Makefile | 2 +-
4 files changed, 20 insertions(+), 3 deletions(-)
create mode 100644 .github/workflows/test-documentation.yml
diff --git a/.github/workflows/test-documentation.yml b/.github/workflows/test-documentation.yml
new file mode 100644
index 0000000..82d23fe
--- /dev/null
+++ b/.github/workflows/test-documentation.yml
@@ -0,0 +1,17 @@
+name: test documentation
+
+on: [ push, pull_request ]
+
+jobs:
+ tests:
+ name: documentation
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Test if the documentation will render without warnings
+ run: |
+ mkdir -p Documentation-GENERATED-temp \
+ && docker run --rm --pull always -v $(pwd):/project \
+ ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test
diff --git a/Documentation/Exceptions/1257246929.rst b/Documentation/Exceptions/1257246929.rst
index 0e08b57..abf7651 100644
--- a/Documentation/Exceptions/1257246929.rst
+++ b/Documentation/Exceptions/1257246929.rst
@@ -41,7 +41,7 @@ Problem: Using an Extbase link with argument "format"
When creating a link like:
-.. code-block:: fluid
+.. code-block:: html
diff --git a/Documentation/Exceptions/1705656657.rst b/Documentation/Exceptions/1705656657.rst
index 1c7ee2d..51c9ffe 100644
--- a/Documentation/Exceptions/1705656657.rst
+++ b/Documentation/Exceptions/1705656657.rst
@@ -18,4 +18,4 @@ This exception is triggered if you attempt to view a page that lacks a TypoScrip
Solution
--------
-:ref:`Create a TypoScript template ` for your site in the site's root page.
+:ref:`Create a TypoScript template ` for your site in the site's root page.
diff --git a/Makefile b/Makefile
index 9e0f401..a32a7ff 100644
--- a/Makefile
+++ b/Makefile
@@ -13,5 +13,5 @@ docs: ## Generate projects docs (from "Documentation" directory)
test-docs: ## Test the documentation rendering
mkdir -p Documentation-GENERATED-temp
- docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log --output-format=html
+ docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --minimal-test