[TASK] Migrate to the new PHP-based rendering (#383)

Releases: main, 12.4, 11.5
TYPO3-Documentation · May 16, 2024 · b525bab · b525bab
1 parent a1d7ce4
commit b525bab
Show file tree

Hide file tree

Showing 11 changed files with 57 additions and 411 deletions.
diff --git a/.github/workflows/test-documentation.yml b/.github/workflows/test-documentation.yml
@@ -0,0 +1,17 @@
+name: Test documentation
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    name: Render 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/Index.rst b/Documentation/Index.rst
@@ -152,4 +152,3 @@ mode.
    :hidden:
 
    Sitemap
-   genindex
diff --git a/Documentation/Major/Index.rst b/Documentation/Major/Index.rst
@@ -50,5 +50,5 @@ Major upgrade
     :titlesonly:
 
     PreupgradeTasks/Index
-    UpgradeCore.rst
+    UpgradeCore
     PostupgradeTasks/Index
diff --git a/Documentation/Major/PreupgradeTasks/Backup.rst.txt b/Documentation/Major/PreupgradeTasks/Backup.rst.txt
@@ -1,7 +1,5 @@
 ..  include:: /Includes.rst.txt
 
-..  _backup:
-
 Make a backup first! If things go wrong, you can at least go back to the old
 version. You need a backup of
 

diff --git a/Documentation/Major/PreupgradeTasks/Index.rst b/Documentation/Major/PreupgradeTasks/Index.rst
@@ -29,7 +29,7 @@ Check that all system requirements for upgrading are met:
 
 * See :ref:`t3start:system-requirements`
 
-.. _make_a_backup:
+.. _preupgradetasks_make_a_backup:
 
 Make A Backup
 =============

diff --git a/Documentation/MigrateContent/Index.rst b/Documentation/MigrateContent/Index.rst
@@ -36,7 +36,7 @@ Via CLI command
 ----------------
 
 Exporting a TYPO3 page tree without php time limit is possible via
-:ref:`Symfony Console Commands (cli) <symfony-console-commands-cli>`.
+:ref:`Symfony Console Commands (cli) <t3coreapi:symfony-console-commands-cli>`.
 
 .. code-block:: bash
    :caption: Composer based installation
@@ -127,7 +127,7 @@ Via CLI command
 ----------------
 
 Importing a TYPO3 page tree without php time limit is possible via
-:ref:`Symfony Console Commands (cli) <symfony-console-commands-cli>`.
+:ref:`Symfony Console Commands (cli) <t3coreapi:symfony-console-commands-cli>`.
 
 .. code-block:: bash
    :caption: Composer based installation

diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst
diff --git a/Documentation/guides.xml b/Documentation/guides.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<guides xmlns="https://www.phpdoc.org/guides" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
+        links-are-relative="true">
+    <extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
+               project-home="https://docs.typo3.org/m/typo3/guide-installation/main/en-us/"
+               project-contact="https://typo3.slack.com/archives/C028JEPJL"
+               project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-Installation"
+               project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-Installation/issues"
+               edit-on-github-branch="main"
+               edit-on-github="TYPO3-Documentation/TYPO3CMS-Guide-Installation"
+               typo3-core-preferred="main"
+    />
+    <project title="TYPO3 Upgrade Guide"
+             release="main (development)"
+             version="main (development)"
+             copyright="since 2012 by the TYPO3 contributors"
+    />
+    <inventory id="t3home" url="https://docs.typo3.org/"/>
+</guides>