Skip to content

Commit

Permalink
[TASK] improve documentation
Browse files Browse the repository at this point in the history
Related: #1399
  • Loading branch information
Starkmann committed Jul 30, 2024
1 parent df15048 commit 50769d9
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions Documentation/Environment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ Development environment
You can run the code quality checks and automated tests locally (using a
local PHP, Composer, and database) or using runTests.sh.

To kickstart the project we suggest the usage of the `TYPO3-testing-distribution <https://github.com/oliverklee/TYPO3-testing-distribution/>`__ by Oliver Klee
as development environment. The distribution comes with a frontend, example data and predefined
plugins.
To kickstart the project we suggest the usage of the
`TYPO3-testing-distribution <https://github.com/oliverklee/TYPO3-testing-distribution/>`__
by Oliver Klee as development environment. The distribution comes with a frontend,
example data and predefined plugins.

.. index:: Clone TYPO3 Testing Distribution
.. code-block:: bash
Expand All @@ -25,7 +26,8 @@ Also clone the tea extension.
git clone [email protected]:FriendsOfTYPO3/tea.git
You can organize the folder structure as you wish, but lets say your folder structure looks like this:
You can organize the folder structure as you wish, but lets say your folder
structure looks like this:

.. index:: Folder structure
.. code-block:: bash
Expand All @@ -35,7 +37,12 @@ You can organize the folder structure as you wish, but lets say your folder stru
tea
Inside the testing distribution there is a file **docker-compose.extensions.yaml.template**
Inside the testing distribution there is a file

.. code-block:: bash
docker-compose.extensions.yaml.template
which mounts the used extensions. This file need to be renamed and adjusted.

.. index:: Create docker-compose.extensions.yaml
Expand Down Expand Up @@ -67,4 +74,4 @@ After that you can start the testing distribution using ddev.
After that you should be able to access the frontend:

https://typo3-testing-12-4.ddev.site:8081/tea/
ddev launch

0 comments on commit 50769d9

Please sign in to comment.