[TASK] Add tests for documantation

dkd-kaehm · May 3, 2024 · becdae1 · becdae1
1 parent 8b10fd7
commit becdae1
Show file tree

Hide file tree

Showing 19 changed files with 72 additions and 18 deletions.
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/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -11,7 +11,6 @@ All the settings for the extension can be made through the TYPO3 Extension Confi
 ..  figure:: /Images/BE_Settings_ExtensionConfiguration_General.png
     :class: with-shadow
     :alt: Extension configuration for EXT:tika
-    :width: 60%
 
 
 Extractor

diff --git a/Documentation/Configuration/SolrCell.rst b/Documentation/Configuration/SolrCell.rst
@@ -26,7 +26,6 @@ Open Extension settings for EXT:tika **General** tab and choose **"Solr Server"*
 ..  figure:: /Images/BE_Settings_ExtensionConfiguration_General.png
     :class: with-shadow
     :alt: Extension configuration for EXT:tika - Choosing Solr Server extractor in General tab
-    :width: 60%
 
     Extension configuration for EXT:tika - Choosing Solr Server extractor in General tab
 

diff --git a/Documentation/Configuration/TikaApp.rst b/Documentation/Configuration/TikaApp.rst
@@ -34,7 +34,6 @@ Open Extension settings for EXT:tika **General** tab and choose **"Tika App"** a
 ..  figure:: /Images/BE_Settings_ExtensionConfiguration_General.png
     :class: with-shadow
     :alt: Extension configuration for EXT:tika - Choosing App extractor in General tab
-    :width: 60%
 
     Extension configuration for EXT:tika - Choosing App extractor in General tab
 

diff --git a/Documentation/Configuration/TikaServer.rst b/Documentation/Configuration/TikaServer.rst
@@ -36,7 +36,6 @@ Open Extension settings for EXT:tika **General** tab and choose **"Tika Server"*
 ..  figure:: /Images/BE_Settings_ExtensionConfiguration_General.png
     :class: with-shadow
     :alt: Extension configuration for EXT:tika - Choosing Server extractor in General tab
-    :width: 60%
 
     Extension configuration for EXT:tika - Choosing Server extractor in General tab
 

diff --git a/Documentation/Releases/10_0.rst b/Documentation/Releases/10_0.rst
@@ -6,6 +6,8 @@
 Release 10.0.2
 ==============
 
+..  include:: HintAboutOutdatedChangelog.rst.txt
+
 **Important**:
 This version contains CVE-2021-44228 fixes for users, who starting
 the Tika Server-daemons within TYPO3 BE or using Tika app modes.

diff --git a/Documentation/Releases/11_0.rst b/Documentation/Releases/11_0.rst
@@ -6,6 +6,8 @@
 Release 11.0.1
 ==============
 
+..  include:: HintAboutOutdatedChangelog.rst.txt
+
 This release is relevant for Apache Solr Cell/server users only.
 To be able to use Apache Solr server as extractor, the EXT:solr v11.5.1+ is required as well.
 

diff --git a/Documentation/Releases/2_1.rst → Documentation/Releases/Archive/2_1.rst b/Documentation/Releases/2_1.rst → Documentation/Releases/Archive/2_1.rst
@@ -6,4 +6,6 @@
 Release 2.1.0
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 In this release we provide compatibility changes that are needed to use EXT:tika with EXT:solr 4.0.0 and PHP 7.0
diff --git a/Documentation/Releases/2_2.rst → Documentation/Releases/Archive/2_2.rst b/Documentation/Releases/2_2.rst → Documentation/Releases/Archive/2_2.rst
@@ -6,6 +6,8 @@
 Release 2.2.0
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 We are happy to announce version 2.2.0 of EXT:tika.
 
 New in this Release

diff --git a/Documentation/Releases/2_3.rst → Documentation/Releases/Archive/2_3.rst b/Documentation/Releases/2_3.rst → Documentation/Releases/Archive/2_3.rst
@@ -6,6 +6,8 @@
 Release 2.3.0
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 We are happy to announce version 2.3.0 of EXT:tika.
 This is compatibility release for TYPO3 CMS LTS 8.
 

diff --git a/Documentation/Releases/2_4.rst → Documentation/Releases/Archive/2_4.rst b/Documentation/Releases/2_4.rst → Documentation/Releases/Archive/2_4.rst
@@ -6,6 +6,8 @@
 Release 2.4.0
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 We are happy to announce version 2.4.0 of EXT:tika.
 This is the release for TYPO3 CMS LTS 8.
 

diff --git a/Documentation/Releases/3_0.rst → Documentation/Releases/Archive/3_0.rst b/Documentation/Releases/3_0.rst → Documentation/Releases/Archive/3_0.rst
@@ -6,6 +6,8 @@
 Release 3.0.0
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 We are happy to announce version 3.0.0 of EXT:tika.
 
 New in this Release

diff --git a/Documentation/Releases/3_1.rst → Documentation/Releases/Archive/3_1.rst b/Documentation/Releases/3_1.rst → Documentation/Releases/Archive/3_1.rst
@@ -6,6 +6,8 @@
 Release 3.1.2
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 We are happy to announce version 3.1.2 of EXT:tika.
 
 New in this Release

diff --git a/Documentation/Releases/4_0.rst → Documentation/Releases/Archive/4_0.rst b/Documentation/Releases/4_0.rst → Documentation/Releases/Archive/4_0.rst
@@ -6,6 +6,8 @@
 Release 4.0.1
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 We are happy to announce version 4.0.1 of EXT:tika.
 
 New in this Release

diff --git a/Documentation/Releases/5_0.rst → Documentation/Releases/Archive/5_0.rst b/Documentation/Releases/5_0.rst → Documentation/Releases/Archive/5_0.rst
@@ -6,6 +6,8 @@
 Release 5.0.1
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 We are happy to announce version 5.0.1 of EXT:tika.
 
 New in this Release

diff --git a/Documentation/Releases/6_0.rst → Documentation/Releases/Archive/6_0.rst b/Documentation/Releases/6_0.rst → Documentation/Releases/Archive/6_0.rst
@@ -6,6 +6,8 @@
 Release 6.0.2
 =============
 
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
+
 **Important**:
 This version contains CVE-2021-44228 fixes for users, who starting
 the Tika Server-daemons within TYPO3 BE or using Tika app modes.

diff --git a/Documentation/Releases/Archive/Index.rst b/Documentation/Releases/Archive/Index.rst
@@ -0,0 +1,24 @@
+..  include:: /Includes.rst.txt
+..  index:: Archive
+.. _releases-archive:
+
+*******
+Archive
+*******
+
+
+|
+
+.. toctree::
+    :titlesonly:
+    :glob:
+
+    6_0
+    5_0
+    4_0
+    3_1
+    3_0
+    2_4
+    2_3
+    2_2
+    2_1
diff --git a/Documentation/Releases/HintAboutOutdatedChangelog.rst.txt b/Documentation/Releases/HintAboutOutdatedChangelog.rst.txt
@@ -0,0 +1,5 @@
+..  attention::
+
+     You are on docs for EXT:tika |release| version.
+     This file may be outdated if you are on wrong release "branch" version.
+     To get the most recent changelog, please choose on the top left dropdown menu the version you are looking for.
diff --git a/Documentation/Releases/Index.rst b/Documentation/Releases/Index.rst
@@ -13,17 +13,7 @@ Releases
     :titlesonly:
     :glob:
 
-    12_0.rst
-    11_0.rst
-    10_0.rst
-    6_0.rst
-    5_0.rst
-    4_0.rst
-    3_1.rst
-    3_0.rst
-    2_4.rst
-    2_3.rst
-    2_2.rst
-    2_1.rst
-
-
+    12_0
+    11_0
+    10_0
+    Archive/Index