From 7e33858434114bab3b22a05960d4c02822bd2b07 Mon Sep 17 00:00:00 2001 From: Sarah McCarthy Date: Sat, 29 Jun 2024 11:59:26 +0200 Subject: [PATCH] Update to use render-guides (#172) * Update to use render-guides Releases:main --------- Co-authored-by: lina.wolf (cherry picked from commit b7b4ea7b2af09bef1f1a0b5b96aa83e189d8ef46) --- .editorconfig | 4 ++ .github/workflows/documentation.yml | 17 ++++++ .../AccessControl/Visibility/Index.rst | 2 - Documentation/Concepts/Accessibility.rst | 2 - Documentation/FileModule/Index.rst | 3 +- Documentation/Index.rst | 5 +- Documentation/Languages/Index.rst | 8 +-- Documentation/Settings.cfg | 61 ------------------- Documentation/genindex.rst | 7 --- Documentation/guides.xml | 23 +++++++ Makefile | 16 +++++ 11 files changed, 68 insertions(+), 80 deletions(-) create mode 100644 .github/workflows/documentation.yml delete mode 100644 Documentation/Settings.cfg delete mode 100644 Documentation/genindex.rst create mode 100644 Documentation/guides.xml create mode 100644 Makefile diff --git a/.editorconfig b/.editorconfig index ccf65af..134bcf7 100644 --- 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 \ No newline at end of file diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..3076117 --- /dev/null +++ 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 index 562e9c3..c2806c7 100644 --- 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 `. -.. include:: /Images/AutomaticScreenshots/PageProperties/Enable.rst.txt - .. _visibility-dates: Publication dates diff --git a/Documentation/Concepts/Accessibility.rst b/Documentation/Concepts/Accessibility.rst index 8831240..75fb2c5 100644 --- 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) ` also offers the ability to create headlines of different levels. diff --git a/Documentation/FileModule/Index.rst b/Documentation/FileModule/Index.rst index 8f400c0..933c939 100644 --- 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) `. diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 06c6aac..8bd9708 100644 --- 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 `; +Once you have installed TYPO3 using the :ref:`TYPO3 - Getting Started Tutorial `; 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 `. +found in the :ref:`Frontend Localization Guide `. .. 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 ` contains detailed -information about setting up a multilingual web site and how to actually -do the translation and localization. +The :ref:`Frontend Localization Guide ` +contains detailed information about setting up a multilingual web site and how to +actually do the translation and localization. The :ref:`Site Handling ` documentation contains information about how to configure your site to add more languages. diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index cf7e934..0000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,61 +0,0 @@ -# More information about this file: -# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg - -[general] - -project = Tutorial for Editors -version = 11.5 -release = 11.5 -copyright = since 2012 by the TYPO3 contributors - -[html_theme_options] - -# "Edit on GitHub" button -github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-Editors -github_branch = 11.5 - -# Footer links -project_home = https://docs.typo3.org/m/typo3/tutorial-editors/11.5/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 -project_discussions = - -use_opensearch = - -[intersphinx_mapping] - -# Official TYPO3 manuals -# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ -# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/ -# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ -t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/11.5/en-us/ -# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ -# t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ -# t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/ -# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ -# t3home = https://docs.typo3.org/ -# t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ -t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/11.5/en-us/ -t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/11.5/en-us/ -t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/11.5/en-us/ -# t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ -# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ -t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/11.5/en-us/ -# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/ -# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/11.5/en-us/ -# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/ -# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - -# TYPO3 system extensions -# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/ -# ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ -# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/ -ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/11.5/en-us/ -ext_form = https://docs.typo3.org/c/typo3/cms-form/11.5/en-us/ -# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/ -ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/ -# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/ -# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/ -ext_seo = https://docs.typo3.org/c/typo3/cms-seo/11.5/en-us/ -# ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ diff --git a/Documentation/genindex.rst b/Documentation/genindex.rst deleted file mode 100644 index 806ec56..0000000 --- a/Documentation/genindex.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. include:: /Includes.rst.txt - -===== -Index -===== - -.. Sphinx will insert here the general index automatically. diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 0000000..c2ff318 --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,23 @@ + + + + + + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..35ecee1 --- /dev/null +++ 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