Skip to content
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.

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

[TASK] Document changes to base-distribution #5084

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
47 changes: 23 additions & 24 deletions Documentation/ApiOverview/DirectoryStructure/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,30 +85,29 @@ This path can be retrieved from the Environment API, see
:file:`packages/`
-----------------

Each web site which is run on TYPO3 **should** have a
:ref:`sitepackage <t3sitepackage:start>`, an extension with a special purpose
containing all templates, styles, images, etc. needed for the theme.

It is usually stored locally and then symlinked into the :ref:`directory-vendor`
folder. Many projects also need custom extensions that can be stored here.

The folder for local packages has to be defined in the project's :file:`composer.json`
to be used:

.. code-block:: json
:caption: composer.json

{
"name": "myvendor/my-project",
"repositories": {
"packages": {
"type": "path",
"url": "packages/*"
}
},
"...": "..."
}

If you installed TYPO3 using the base distribution `composer create "typo3/cms-base-distribution"`
this folder is automatically created and registered as repository in the the :file:`composer.json`.

You can put your site package and other extensions to be installed locally here. Then you can just
install the extension with `composer install myvendor/my-sitepackage`.

If you did not use the base-distribution, create the directory and add it to your repositories
manualy:

.. code-block:: diff
:caption: composer.json (diff)

{
"name": "myvendor/my-project",
"repositories": [
+ {
+ "type": "path",
+ "url": "packages/*"
}
],
"...": "..."
}

.. _directory-public:

:file:`public/`
Expand Down