Since May 29th 2019 a new infrastructure is in place at docs.typo3.org. This requires some migration tasks, in order to ensure that extension documentation is rendered on docs.typo3.org
The necessary steps are:
composer.json, see composer.json
This file is necessary, in order to determine required information, like vendor, package name and supported TYPO3 version.
Documentation/Settings.cfg, see Settings.cfg
If this file does not exist, your documentation will get rendered, but the title will not be displayed in the left sidebar.
We may drop this requirement in the future, but for now it is recommended to at least add a minimal
Add new webhook, see Webhook
The legacy webhook is no longer necessary, as explained in Legacy webhook.
Inform the TYPO3 Documentation Team, within #typo3-documentation Slack channel (you must register for Slack first). Alternatively, you can request a redirect by commenting in this GitHub issue The team will setup the redirects from existing legacy rendering to current rendering:
- legacy URL:
- new URL:
- legacy URL:
Check your rendered documentation. Contact us on Slack (#typo3-documentation) if there are problems you cannot fix yourself.
Info About Changes¶
The TER (TYPO3 Extension Repository) will no longer trigger documentation rendering. Therefore uploading an extension at extensions.typo3.org does not automatically trigger rendering anymore.
In order to release a new version of an extension:
There is no change necessary. https://docs.typo3.org/ does no longer show three
level version numbers in form of
Major.Minor.Patch. Only the first two
levels are shown
This reduces the amount of documentation while keeping relevant information, as patch levels should not introduce breaking changes or new features.
The rendering supports two branches within repositories:
- Should contain the current development state, used for upcoming release.
Every push to this branch triggers a new rendering, available at
Should contain a draft of the documentation. Every push to this branch triggers a new rendering, available at
https://docs.typo3.org/p/<vendor>/<package>/draft/en-us/(same URL as master, except master is replaced by draft).
This state is not indexed by search engines. This branch can be used to test rendering before releasing a new version of an extension.
In order to test a different rendering, remove the branch, and create it again.
Existing legacy documentation is kept until end of 2020. Each documentation contains an information block that it’s outdated, together with a link to the necessary steps.
The URL structure has changed. Redirects are in place.
The URL structure now consists of the following parts:
- Collects all packages of the same vendor, e.g. “typo3” or a company providing extensions. Same as on packagist.org.
- Defines the package. Same as on packagist.org.
- Defines the version, either in form of “Major.Minor” or
- Defines the locale, e.g.
- Currently, the project cannot be rendered if the Start File is
README.rst(or .md) and not
Documentation/Index.rst. This is a known problem and already fixed in the development version of our Docker container. We will update this on the server shortly. You can use the v2.1.0 version of the Docker container locally.
- A single-file solution (without toctree) may have problems with the menu. This is also a known problem and already fixed in development version.
Here we show some common errors you can and should fix yourself.
Contact us on Slack, if you need help!
We also made some changes to the example extension manual.
Make sure to use the updated version if you want to start an extension from scratch!