!!![TASK][BACKPORT 12.4] Render main with PHP based guides-rendering (#…

…326)

.github/workflows/test-documentation.yml

@@ -0,0 +1,17 @@
+name: test documentation
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    name: test-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

Documentation/Includes.rst.txt

@@ -1,34 +1,2 @@
-.. More information about this file:
-   https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
-
-.. ----------
-.. text roles
-.. ----------
-
-.. role:: aspect(emphasis)
-.. role:: bash(code)
-.. role:: html(code)
-.. role:: js(code)
-.. role:: php(code)
-.. role:: rst(code)
-.. role:: sep(strong)
-.. role:: sql(code)
-
-.. role:: tsconfig(code)
-   :class: typoscript
-
-.. role:: typoscript(code)
-.. role:: xml(code)
-   :class: html
-
-.. role:: yaml(code)
-
-.. default-role:: code
-
-.. ---------
-.. highlight
-.. ---------
-
-.. By default, code blocks use PHP syntax highlighting
-
-.. highlight:: php
+..  this file can be used to include information on the top of each page
+..  for example to add a hint for outdated versions

Documentation/Localization.ru_RU/Includes.rst.txt

@@ -1,34 +1,2 @@
-.. More information about this file:
-   https://docs.typo3.org/m/typo3/docs-how-to-document/main/ru-ru/GeneralConventions/FileStructure.html#includes-rst-txt
-
-.. ----------
-.. text roles
-.. ----------
-
-.. role:: aspect(emphasis)
-.. role:: bash(code)
-.. role:: html(code)
-.. role:: js(code)
-.. role:: php(code)
-.. role:: rst(code)
-.. role:: sep(strong)
-.. role:: sql(code)
-
-.. role:: tsconfig(code)
-   :class: typoscript
-
-.. role:: typoscript(code)
-.. role:: xml(code)
-   :class: html
-
-.. role:: yaml(code)
-
-.. default-role:: code
-
-.. ---------
-.. highlight
-.. ---------
-
-.. By default, code blocks use PHP syntax highlighting
-
-.. highlight:: php
+..  this file can be used to include information on the top of each page
+..  for example to add a hint for outdated versions

Documentation/Localization.ru_RU/guides.xml

@@ -0,0 +1,24 @@
+<?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/tutorial-getting-started/main/ru-ru/"
+             project-contact="https://typo3.slack.com/archives/C028JEPJL"
+             project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted"
+             project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues"
+             edit-on-github-branch="12.4"
+             edit-on-github="TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted"
+             typo3-core-preferred="stable"
+             interlink-shortcode="t3start"
+  />
+  <project title="Getting Started"
+           release="12.4"
+           version="12.4"
+           copyright="since 2012 by the TYPO3 contributors"/>
+
+  <inventory id="t3start11" url="https://docs.typo3.org/m/typo3/tutorial-getting-started/11.5/ru-ru/"/>
+  <inventory id="t3coreapi" url="https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/"/>
+  <inventory id="t3editors" url="https://docs.typo3.org/m/typo3/tutorial-editors/main/ru-ru/"/>
+  <inventory id="t3sitepackage" url="https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/"/>
+  <inventory id="ext_workspaces" url="https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/"/>
+  <inventory id="ext_surf" url="https://docs.typo3.org/other/typo3/surf/main/en-us/"/>
+</guides>

Documentation/guides.xml

@@ -0,0 +1,26 @@
+<?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"
+>
+    <extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
+           edit-on-github="TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted"
+           edit-on-github-branch="12.4"
+           typo3-core-preferred="main"
+           interlink-shortcode="t3start"
+           project-home="https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/"
+           project-contact="https://typo3.slack.com/archives/C028JEPJL"
+           project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted"
+           project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues"
+    />
+    <project
+            title="Getting Started"
+            version="12.4"
+            release="12.4"
+            copyright="since 2012 by the TYPO3 contributors"
+    />
+    <inventory id="t3start11" url="https://docs.typo3.org/m/typo3/tutorial-getting-started/11.5/en-us/" />
+    <inventory id="ext_surf" url="https://docs.typo3.org/other/typo3/surf/main/en-us/" />
+
+</guides>

Makefile

@@ -0,0 +1,10 @@
+.PHONY: help
+help: ## Displays this list of targets with descriptions
+	@echo "The following commands are available:\n"
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: docs
+docs: ## Generate projects docs (from "Documentation" directory)
+	mkdir -p Documentation-GENERATED-temp
+
+	docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation