Skip to content

Improve documentation with findings from onsite sprint #2008

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DanielSiepmann merged 9 commits into from
Mar 28, 2026
Merged

Improve documentation with findings from onsite sprint #2008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
71a29d2
[FEATURE] clarify the usage of ssh key and TYPO3 testing distribution
Starkmann Mar 26, 2026
d5bf316
[FEATURE] mention TYPO3 version in url
Starkmann Mar 26, 2026
e1b24de
[TASK] add hint for composer install
Starkmann Mar 26, 2026
2d19056
Update Documentation/Environment.rst
Starkmann Mar 26, 2026
5c839be
Update Documentation/Environment.rst
Starkmann Mar 26, 2026
48505a8
Update Documentation/Environment.rst
Starkmann Mar 26, 2026
7854bd2
Update Documentation/Environment.rst
Starkmann Mar 26, 2026
ff78a9c
Update Documentation/Environment.rst
Starkmann Mar 26, 2026
a42dbe7
Apply suggestion from @DanielSiepmann
DanielSiepmann Mar 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion Documentation/Environment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,19 @@ To kickstart the project, we suggest the usage of the
by Oliver Klee as development environment. The distribution comes with a frontend,
example data and predefined plugins.

The following commands expect that your SSH key is known by GitHub. If not, you need to use `https://`.

.. index:: Clone TYPO3 Testing Distribution
.. code-block:: bash

git clone git@github.com:oliverklee/TYPO3-testing-distribution.git

Also clone the tea extension.
Please checkout the branch for the TYPO3 version you need. e.g. `12.x`.
For more information about the TYPO3-testing-distribution (e.g. backend user credentials), use the documentation:
https://github.com/oliverklee-de/TYPO3-testing-distribution/blob/13.x/README.md (TYPO3 13)
Adjust link to your needed version.



.. index:: Clone Tea Extension
.. code-block:: bash
Expand Down
4 changes: 4 additions & 0 deletions Documentation/Running.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ display a list of all available Composer commands and scripts. For all custom
Composer scripts there are descriptions in the `script-description` section of
the `composer.json`.

Keep in mind that certain commands only work if you have run
:bash:`composer install` or :bash:`./Build/Scripts/runTests.sh -s composer install`
before.

If you have problems with missing dependencies on your local machine, it is
recommended to execute tests with the usage of the `runTests.sh` script.

Expand Down