diff --git a/.ddev/config.yaml b/.ddev/config.yaml index 7041aa2..bb387ad 100644 --- a/.ddev/config.yaml +++ b/.ddev/config.yaml @@ -16,7 +16,7 @@ hooks: post-start: - exec: composer install --no-progress omit_containers: [dba, ddev-ssh-agent] -webimage_extra_packages: [parallel] +webimage_extra_packages: [parallel, build-essential] use_dns_when_possible: true composer_version: "2.4" web_environment: diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..79ac662 --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,17 @@ +name: test documentation + +on: [ push, pull_request ] + +jobs: + tests: + name: 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/CreatePages/Index.rst b/Documentation/CreatePages/Index.rst index 3ef3576..90d684a 100644 --- a/Documentation/CreatePages/Index.rst +++ b/Documentation/CreatePages/Index.rst @@ -70,7 +70,7 @@ Now save your changes by clicking the :guilabel:`Save` button at the top. .. hint:: The item "Site Package" was created by the file :file:`Configuration/TCA/Overrides/sys_template.php` in the step - :ref:`Make TypoScript available`. + :ref:`Make TypoScript available `. Preview the page diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg deleted file mode 100644 index 2d6dc25..0000000 --- a/Documentation/Settings.cfg +++ /dev/null @@ -1,60 +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 = Sitepackage Tutorial -version = main (development) -release = main (development) -copyright = since 2017 by the TYPO3 contributors - -[html_theme_options] - -# "Edit on GitHub" button -github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage -github_branch = main - -# Footer links -project_home = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ -project_contact = https://typo3.slack.com/archives/C028JEPJL -project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage -project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage/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/main/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/ -# 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/main/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/main/en-us/ diff --git a/Documentation/Summary/Index.rst b/Documentation/Summary/Index.rst index e06ae89..d5df6f8 100644 --- a/Documentation/Summary/Index.rst +++ b/Documentation/Summary/Index.rst @@ -137,9 +137,7 @@ Tutorial - Sitepackages - Part 1 of 3 `YouTube: Part 1 of 3 `__ -.. only:: html or singlehtml - - .. youtube:: HtBmim7pc0o +.. youtube:: HtBmim7pc0o Tutorial - Sitepackages - Part 2 of 3 @@ -147,9 +145,7 @@ Tutorial - Sitepackages - Part 2 of 3 `YouTube: Part 2 of 3 `__ -.. only:: html or singlehtml - - .. youtube:: deSMVfCSCXY +.. youtube:: deSMVfCSCXY Tutorial - Sitepackages - Part 3 of 3 @@ -157,9 +153,7 @@ Tutorial - Sitepackages - Part 3 of 3 `YouTube: Part 3 of 3 `__ -.. only:: html or singlehtml - - .. youtube:: SEoWOBT0rQE +.. youtube:: SEoWOBT0rQE Searches ======== diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 0000000..ff7a005 --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,20 @@ + + + + + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..2ea329e --- /dev/null +++ b/Makefile @@ -0,0 +1,14 @@ +.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: codesnippets +codesnippets: ## Regenerate automatic code snippets + .Build/vendor/bin/typo3 codesnippet:create Documentation/CodeSnippets/ + +.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