diff --git a/.github/workflows/test-documentation.yml b/.github/workflows/test-documentation.yml new file mode 100644 index 00000000..85ec9d96 --- /dev/null +++ b/.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 diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt index 469841d3..cdfcd2ed 100644 --- a/Documentation/Includes.rst.txt +++ b/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 diff --git a/Documentation/Localization.ru_RU/Includes.rst.txt b/Documentation/Localization.ru_RU/Includes.rst.txt index f0916ea0..cdfcd2ed 100644 --- a/Documentation/Localization.ru_RU/Includes.rst.txt +++ b/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 diff --git a/Documentation/Localization.ru_RU/Settings.cfg b/Documentation/Localization.ru_RU/Settings.cfg deleted file mode 100644 index 3ef8cf01..00000000 --- a/Documentation/Localization.ru_RU/Settings.cfg +++ /dev/null @@ -1,64 +0,0 @@ -# More information about this file: -# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-en/GeneralConventions/FileStructure.html#settings-cfg - -[general] - -project = Getting Started -version = 12.4 -release = 12.4 -copyright = since 2012 by the TYPO3 contributors - -[html_theme_options] - -# "Edit on GitHub" button -github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted -github_branch = main - -# Footer links -project_home = https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/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 -project_discussions = - -use_opensearch = - -[intersphinx_mapping] - - -t3start11 = https://docs.typo3.org/m/typo3/tutorial-getting-started/11.5/ru-ru/ - -# Official TYPO3 manuals -# h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/12.4/en-en/ -# t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/12.4/en-en/ -# t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/12.4/en-en/ -t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/12.4/en-en/ -# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/12.4/en-en/ -t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/12.4/ru-ru/ -# t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/12.4/en-en/ -# t3home = https://docs.typo3.org/ -# t3install = https://docs.typo3.org/m/typo3/guide-installation/12.4/en-en/ -# t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/12.4/en-en/ -t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/12.4/en-en/ -# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/ru-ru/ -# t3tca = https://docs.typo3.org/m/typo3/reference-tca/12.4/en-en/ -# t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/12.4/en-en/ -# t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/12.4/en-en/ -# t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/12.4/en-en/ -# t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/12.4/en-en/ -# t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/12.4/en-en/ -# t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/12.4/en-en/ - -# TYPO3 system extensions -# ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/12.4/en-en/ -# ext_core = https://docs.typo3.org/c/typo3/cms-core/12.4/en-en/ -# ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/12.4/en-en/ -# ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/12.4/en-en/ -# ext_form = https://docs.typo3.org/c/typo3/cms-form/12.4/en-en/ -# ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/12.4/en-en/ -# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/12.4/en-en/ -# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/12.4/en-en/ -# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/12.4/en-en/ -# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/12.4/en-en/ -ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/12.4/en-en/ -ext_surf = https://docs.typo3.org/other/typo3/surf/12.4/en-en/ diff --git a/Documentation/Localization.ru_RU/guides.xml b/Documentation/Localization.ru_RU/guides.xml new file mode 100644 index 00000000..d7935a4c --- /dev/null +++ b/Documentation/Localization.ru_RU/guides.xml @@ -0,0 +1,24 @@ + + + + + + + + + + + + diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index 16d7d682..00000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,64 +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 = Getting Started -version = 12.4 -release = 12.4 -copyright = since 2012 by the TYPO3 contributors - -[html_theme_options] - -# "Edit on GitHub" button -github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted -github_branch = 12.4 - -# Footer links -project_home = https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/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_discussions = - -use_opensearch = - -[intersphinx_mapping] - - -t3start12 = https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/en-us/ - -# 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/12.4/en-us/ -# t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ -t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/12.4/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/main/en-us/ -t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/12.4/en-us/ -# t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/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/main/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/main/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/main/en-us/ -# ext_form = https://docs.typo3.org/c/typo3/cms-form/main/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/main/en-us/ -ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/12.4/en-us/ -ext_surf = https://docs.typo3.org/other/typo3/surf/12.4/en-us/ diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 00000000..774d5a40 --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,26 @@ + + + + + + + + diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..97039388 --- /dev/null +++ b/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