Migrate Documentation ¶
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
Necessary Steps ¶
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, documentation will get rendered, but title will not be displayed in the left sidebar.
This requirement may be dropped in the future.For now it is necessary to at least add a minimal
Example for very minimal Settings.cfg, for full example see Settings.cfg :
[general] project = Extension name release = latest
Add new webhook, see Webhook
In case the old hook is in play, remove it first, and add the new one instead.
Inform the TYPO3 Documentation Team, within #typo3-documentation Slack channel. Registration for Slack is available at my.typo3.org . Alternatively, a redirect can be requested by commenting in this GitHub issue .
The team will setup the redirects from existing legacy rendering to current rendering:
- legacy URL:
Info About Changes ¶
Extension Release ¶
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:
Version Numbers ¶
There is no change necessary.
does no longer show three
level version numbers in form of
. 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.
Supported branches ¶
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 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 Documentation ¶
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.
In order to migrate, follow Migrate Documentation . The Documentation Team can setup redirects for old documentation to new documentation afterwards. Send a message within Slack #typo3-documentation .
URL Structure ¶
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.