Update to use render-guides (#172)

* Update to use render-guides Releases:main --------- Co-authored-by: lina.wolf <lwolf@w-commerce.de> (cherry picked from commit b7b4ea7)
TYPO3-Documentation · Jun 29, 2024 · 7e33858 · 7e33858
1 parent 625ae9f
commit 7e33858
Show file tree

Hide file tree

Showing 11 changed files with 68 additions and 80 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -23,3 +23,7 @@ trim_trailing_whitespace = true
 indent_style = space
 indent_size = 4
 max_line_length = 80
+
+[{Makefile,**.mk}]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab
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: 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/AccessControl/Visibility/Index.rst b/Documentation/AccessControl/Visibility/Index.rst
@@ -14,8 +14,6 @@ In the Core, and in extensions that follow best practice, all options related
 to visibility are controlled in the :guilabel:`Access` tab of the :ref:`page
 properties <pages-properties>`.
 
-.. include:: /Images/AutomaticScreenshots/PageProperties/Enable.rst.txt
-
 .. _visibility-dates:
 
 Publication dates

diff --git a/Documentation/Concepts/Accessibility.rst b/Documentation/Concepts/Accessibility.rst
@@ -41,8 +41,6 @@ the heading (:guilabel:`Headlines > Type`). The choice of the level of the
 heading should be made in accordance to the semantics of the text and not according to
 design choices.
 
-.. include:: /Images/AutomaticScreenshots/NewContentElement/NewContentElement.rst.txt
-
 The :ref:`rich text editor (RTE) <rte>` also offers the ability to create
 headlines of different levels.
 

diff --git a/Documentation/FileModule/Index.rst b/Documentation/FileModule/Index.rst
@@ -94,5 +94,6 @@ Next steps
 ==========
 
 The next chapters cover configuration and administration tasks that
-require special access privileges as described in :ref:`privileges`.
+require special access privileges as described in :ref:`Access control in the
+backend (users and groups) <t3coreapi:access>`.
 
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -5,7 +5,7 @@
 TYPO3 Editors Guide
 ===================
 
-Once you have installed TYPO3 using the :doc:`Getting Started Guide <t3start:Index>`;
+Once you have installed TYPO3 using the :ref:`TYPO3 - Getting Started Tutorial <t3start:start>`;
 the next step is to log in to the backend of the CMS and start adding pages and create
 some content. In the TYPO3 world we often call users who carry out these tasks "Editors".
 
@@ -30,7 +30,7 @@ the `Official Introduction Package <https://extensions.typo3.org/extension/intro
 
  .. rst-class:: card-header h3
 
- .. rubric:: :ref:`Getting Started`
+ .. rubric:: Getting Started
 
  .. container:: card-body
 
@@ -155,4 +155,3 @@ the `Official Introduction Package <https://extensions.typo3.org/extension/intro
  :hidden:
 
  Sitemap
- genindex
diff --git a/Documentation/Languages/Index.rst b/Documentation/Languages/Index.rst
@@ -11,7 +11,7 @@ TYPO3 CMS comes with the built-in ability to handle web sites
 in multiple languages.
 
 Detailed information about setting up a multilingual web site is
-found in the :doc:`Frontend Localization Guide <t3l10n:Index>`.
+found in the :ref:`Frontend Localization Guide <typo3/guide-frontendlocalization:start>`.
 
 .. youtube:: B9TKbc7c7oI
 
@@ -131,9 +131,9 @@ translation. You can view a single language at a time by switching back to the
 
 Next steps
 ==========
-The :doc:`Frontend Localization Guide <t3l10n:Index>` contains detailed
-information about setting up a multilingual web site and how to actually
-do the translation and localization.
+The :ref:`Frontend Localization Guide <typo3/guide-frontendlocalization:start>`
+contains detailed information about setting up a multilingual web site and how to
+actually do the translation and localization.
 
 The :ref:`Site Handling <t3coreapi:sitehandling-basics>` documentation contains
 information about how to configure your site to add more languages.
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,23 @@
+<?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-editors/main/en-us/"
+ project-contact="https://typo3.slack.com/archives/C028JEPJL"
+ project-repository="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Editors"
+ project-issues="https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-Editors/issues"
+ edit-on-github-branch="11.5"
+ edit-on-github="TYPO3-Documentation/TYPO3CMS-Tutorial-Editors"
+ typo3-core-preferred="11.5"
+ interlink-shortcode="t3editors"
+ />
+ <project
+ title="Tutorial for Editors"
+ release="11.5"
+ version="11.5"
+ copyright="since 2012 by the TYPO3 contributors"
+ />
+ <inventory id="typo3/guide-frontendlocalization"
+ url="https://docs.typo3.org/m/typo3/guide-frontendlocalization/11.5/en-us/"/>
+</guides>
diff --git a/Makefile b/Makefile
@@ -0,0 +1,16 @@
+.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
+
+
+.PHONY: test-docs
+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