georgringer · georgringer · Feb 19, 2024 · Jan 10, 2024 · Jan 10, 2024 · Jan 11, 2024
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -40,6 +40,17 @@ email, or any other method with the owners of this repository before making a ch
 
 For changes of a trivial nature, it is not always necessary to create a new issue.
 
+## Render the documentation locally
+
+To render the documentation locally you can use the following `make` command:
+
+```
+    make docs
+```
+
+If `make` is not available on your machine you can also call the commands provided
+in the file `Makefile` manually.
+
 ## Additional resources
 
 * [Rendered documentation](https://docs.typo3.org/p/georgringer/news/main/en-us/)

diff --git a/.github/workflows/documentation.yml b/.github/workflows/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 --fail-on-log
diff --git a/Documentation/Addons/Index.rst b/Documentation/Addons/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _addons:
 
 Addons

diff --git a/Documentation/Addons/NewsAdministration/Index.rst b/Documentation/Addons/NewsAdministration/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsAdministration:
 
 =======================

diff --git a/Documentation/Addons/NewsCategoryPidConstraint/Index.rst b/Documentation/Addons/NewsCategoryPidConstraint/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsCategoryPidConstraint:
 
 ================================

diff --git a/Documentation/Addons/NewsContentElements/Index.rst b/Documentation/Addons/NewsContentElements/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsContentElements:
 
 =========================

diff --git a/Documentation/Addons/NewsFegroupPreview/Index.rst b/Documentation/Addons/NewsFegroupPreview/Index.rst
@@ -1,6 +1,4 @@
-    .. include:: /Includes.rst.txt
-
-.. _newsFegroupPreview:
+    .. _newsFegroupPreview:
 
 ========================
 EXT:news_fegroup_preview

diff --git a/Documentation/Addons/NewsFilter/Index.rst b/Documentation/Addons/NewsFilter/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsFilter:
 
 ===============

diff --git a/Documentation/Addons/NewsImporticsxml/Index.rst b/Documentation/Addons/NewsImporticsxml/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsImporticsxml:
 
 =====================

diff --git a/Documentation/Addons/NewsRedirectSlugChange/Index.rst b/Documentation/Addons/NewsRedirectSlugChange/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsRedirectSlugChange:
 
 =============================

diff --git a/Documentation/Addons/NewsSeo/Index.rst b/Documentation/Addons/NewsSeo/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsSeo:
 
 ============

diff --git a/Documentation/Addons/NewsTagsuggest/Index.rst b/Documentation/Addons/NewsTagsuggest/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _newsTagsuggest:
 
 ===================

diff --git a/Documentation/Addons/NumberedPagination/Index.rst b/Documentation/Addons/NumberedPagination/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _numberedPagination:
 
 =======================

diff --git a/Documentation/Administration/Configuration/Index.rst b/Documentation/Administration/Configuration/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _configuration:
 
 Configuration

diff --git a/Documentation/Administration/Index.rst b/Documentation/Administration/Index.rst
@@ -1,7 +1,4 @@
-.. include:: /Includes.rst.txt
-
-
-.. _admin-manual:
+.. _admin-manual:
 
 Administration
 ==============

diff --git a/Documentation/Administration/Installation/Index.rst b/Documentation/Administration/Installation/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _installation:
 
 Installation

diff --git a/Documentation/Administration/Migration/Index.rst b/Documentation/Administration/Migration/Index.rst
@@ -1,6 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
 Migration
 ---------
 

diff --git a/Documentation/Administration/Migration/MigrationFromRealurl/Index.rst b/Documentation/Administration/Migration/MigrationFromRealurl/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _migration_realurl_routing:
 
 ===========================================

diff --git a/Documentation/Administration/Migration/MigrationFromTtNews/Index.rst b/Documentation/Administration/Migration/MigrationFromTtNews/Index.rst
@@ -1,6 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
 Migration from tt_news to news
 ------------------------------
 This tutorial will help you to migrate data from tt_news to news.

diff --git a/Documentation/Administration/Update/Index.rst b/Documentation/Administration/Update/Index.rst
@@ -1,6 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
 Updating
 --------
 If you update EXT:news to a newer version, please read this section carefully!

diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 ..  _start:
 
 ===========

diff --git a/Documentation/Introduction/About/Index.rst b/Documentation/Introduction/About/Index.rst
@@ -1,6 +1,4 @@
-.. include:: /Includes.rst.txt
-
-.. _whatDoesItDo:
+.. _whatDoesItDo:
 
 What does it do?
 ================

diff --git a/Documentation/Introduction/Contribution/Index.rst b/Documentation/Introduction/Contribution/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _contribution:
 
 Contribution

diff --git a/Documentation/Introduction/Sponsoring/Index.rst b/Documentation/Introduction/Sponsoring/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _thanks:
 .. _sponsoring:
 

diff --git a/Documentation/Introduction/Support/Index.rst b/Documentation/Introduction/Support/Index.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 .. _support:
 
 Need Support?

diff --git a/Documentation/Misc/Changelog/10-0-0.rst b/Documentation/Misc/Changelog/10-0-0.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 10.0.0 - 20th September 2022
 ============================
 

diff --git a/Documentation/Misc/Changelog/10-0-1.rst b/Documentation/Misc/Changelog/10-0-1.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 10.0.1 - 22nd September 2022
 ============================
 

diff --git a/Documentation/Misc/Changelog/10-0-2.rst b/Documentation/Misc/Changelog/10-0-2.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 10.0.2 - 27th October 2022
 ==========================
 

diff --git a/Documentation/Misc/Changelog/10-0-3.rst b/Documentation/Misc/Changelog/10-0-3.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 10.0.3 - 21st November 2022
 ===========================
 

diff --git a/Documentation/Misc/Changelog/11-0-0.rst b/Documentation/Misc/Changelog/11-0-0.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 11.0.0 - 9th March 2023
 =======================
 

diff --git a/Documentation/Misc/Changelog/11-1-0.rst b/Documentation/Misc/Changelog/11-1-0.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 11.1.0 - 23rd June 2023
 =======================
 

diff --git a/Documentation/Misc/Changelog/11-1-1.rst b/Documentation/Misc/Changelog/11-1-1.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 11.1.1 - 26th June 2023
 =======================
 

diff --git a/Documentation/Misc/Changelog/11-1-2.rst b/Documentation/Misc/Changelog/11-1-2.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 11.1.2 - 14th July 2023
 =======================
 

diff --git a/Documentation/Misc/Changelog/11-2-0.rst b/Documentation/Misc/Changelog/11-2-0.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 11.2.0 - 30th August 2023
 =========================
 

diff --git a/Documentation/Misc/Changelog/11-3-0.rst b/Documentation/Misc/Changelog/11-3-0.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 11.3.0 - 20th December 2023
 ===========================
 

diff --git a/Documentation/Misc/Changelog/11-4-0.rst b/Documentation/Misc/Changelog/11-4-0.rst
@@ -1,4 +1,3 @@
-.. include:: /Includes.rst.txt
 
 11.4.0 - 8th February 2024
 ==========================

diff --git a/Documentation/Misc/Changelog/11-4-1.rst b/Documentation/Misc/Changelog/11-4-1.rst
@@ -1,4 +1,3 @@
-.. include:: /Includes.rst.txt
 
 11.4.1 - 8th February 2024
 ==========================

diff --git a/Documentation/Misc/Changelog/2-1-0.rst b/Documentation/Misc/Changelog/2-1-0.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 2.1.0 - 2013/03/28
 ------------------
 

diff --git a/Documentation/Misc/Changelog/2-2-0.rst b/Documentation/Misc/Changelog/2-2-0.rst
@@ -1,7 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
-
 2.2.0 - 2013/07/06
 ------------------
 

diff --git a/Documentation/Misc/Changelog/2-2-1.rst b/Documentation/Misc/Changelog/2-2-1.rst
@@ -1,7 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
-
 2.2.1 - 2013/09/23
 ------------------
 

diff --git a/Documentation/Misc/Changelog/2-3-0.rst b/Documentation/Misc/Changelog/2-3-0.rst
@@ -1,7 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
-
 2.3.0 - 2013/12/12
 ------------------
 

diff --git a/Documentation/Misc/Changelog/3-0-0.rst b/Documentation/Misc/Changelog/3-0-0.rst
@@ -1,7 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
-
 3.0.0 - 2014/05/16
 ------------------
 

diff --git a/Documentation/Misc/Changelog/3-0-1.rst b/Documentation/Misc/Changelog/3-0-1.rst
@@ -1,7 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
-
 3.0.1 - 2014/06/03
 ------------------
 

diff --git a/Documentation/Misc/Changelog/3-1-0.rst b/Documentation/Misc/Changelog/3-1-0.rst
@@ -1,7 +1,3 @@
-.. include:: /Includes.rst.txt
-
-
-
 3.1.0 - 2015/02/12
 ------------------
 

diff --git a/Documentation/Misc/Changelog/3-2-0.rst b/Documentation/Misc/Changelog/3-2-0.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 3.2.0 - 2015/05/19
 ==================
 

diff --git a/Documentation/Misc/Changelog/3-2-1.rst b/Documentation/Misc/Changelog/3-2-1.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 3.2.1 - 2015/07/11
 ==================
 

diff --git a/Documentation/Misc/Changelog/3-2-2.rst b/Documentation/Misc/Changelog/3-2-2.rst
@@ -1,5 +1,3 @@
-.. include:: /Includes.rst.txt
-
 3.2.1 - 2015/07/13
 ==================