Publish Your Extension¶
By publishing an extension, we mean making it publicly available. This includes:
- Register your extension on Packagist
- Register your extension on extensions.typo3.org (TER)
- Make your extension source code available on a public Git hoster such as GitHub, Gitlab or Bitbucket
- Register Your Extension for docs.typo3.org: This makes sure your extension documentation will be rendered on docs.typo3.org
We recommend to do all of these. Find more information in the following sections.
TYPO3 - Inspiring people to share
Publish Your Extension on Packagist¶
This is described well on Packagist.
- It is possible to install your extension using
Publish Your Extension on TER¶
- The community can vote for your extension
- Donate link (optional)
- Link to the documentation (optional)
- Link to the source code (optional)
Publish Source Code on a Public Git Hosting Platform¶
The TYPO3 community currently uses GitHub, GitLab and Atlassian Bitbucket to host the Git repositories of their extensions.
Add a repository to your workspace. Typically, the extension key is used for the repository name, but that is not necessary.
- Contributors can add issues or pull requests
- Render the documentation on docs.typo3.org (see next step) by adding a webhook
Register Your Extension for docs.typo3.org¶
This basically means that you will add a webhook in your extension repository.
In order for this to work, you must have a
composer.json and push some
changes after you register the webhook.
All the necessary steps are outlined in Register for docs.typo3.org except for step 4 (request redirects) which is not necessary for new documentation.
- Your extension documentation will be rendered on docs.typo3.org
- The documentation link will be added automatically if your extension is registered on extensions.typo3.org (TER).