Skip to content

Commit

Permalink
[TASK] Switch Tutorial in main branch to the new rendering (#147)
Browse files Browse the repository at this point in the history
* [TASK] Render as draft with the render-guides

* [TASK] Remove superfluous "only" directive

* [TASK] Correct guides.xml

* [TASK] Delete wrong guides.xml location

* [TASK] Introduce test workflow

* [TASK] Introduce make for rendering and codesnippets

* [TASK] Remove manually defined inventories (#146)

* [TASK] Move missing information from Settings.cfg to guides.xml
  • Loading branch information
linawolf authored Feb 15, 2024
1 parent 12d096f commit 3953eee
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 71 deletions.
2 changes: 1 addition & 1 deletion .ddev/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
17 changes: 17 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion Documentation/CreatePages/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<make-typoscript-available>`.
:ref:`Make TypoScript available <make-typoscript-available>`.


Preview the page
Expand Down
60 changes: 0 additions & 60 deletions Documentation/Settings.cfg

This file was deleted.

12 changes: 3 additions & 9 deletions Documentation/Summary/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -137,29 +137,23 @@ Tutorial - Sitepackages - Part 1 of 3

`YouTube: Part 1 of 3 <https://www.youtube.com/watch?v=HtBmim7pc0o>`__

.. only:: html or singlehtml

.. youtube:: HtBmim7pc0o
.. youtube:: HtBmim7pc0o


Tutorial - Sitepackages - Part 2 of 3
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`YouTube: Part 2 of 3 <https://www.youtube.com/watch?v=deSMVfCSCXY>`__

.. only:: html or singlehtml

.. youtube:: deSMVfCSCXY
.. youtube:: deSMVfCSCXY


Tutorial - Sitepackages - Part 3 of 3
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`YouTube: Part 3 of 3 <https://www.youtube.com/watch?v=SEoWOBT0rQE>`__

.. only:: html or singlehtml

.. youtube:: SEoWOBT0rQE
.. youtube:: SEoWOBT0rQE

Searches
========
Expand Down
20 changes: 20 additions & 0 deletions Documentation/guides.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?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-SitePackage"
edit-on-github-branch="main"
typo3-core-preferred="main"
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 title="Sitepackage Tutorial"
version="main (development)"
release="main (development)"
copyright="since 2017 by the TYPO3 contributors"
/>
</guides>
14 changes: 14 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 3953eee

Please sign in to comment.