By publishing an extension, we mean making it publicly available. This may include all of or just a few of the following:
Register your extension on Packagist <publish-extension-packagist>
Register your extension on extensions.typo3.org <publish-extension-ter>
(TER)- Make your
extension source code available <publish-extension-git>
on a public Git hoster such as GitHub, Gitlab or Bitbucket Register Your Extension for docs.typo3.org <publish-extension-docs>
: 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
This is described well on Packagist.
Advantages:
- It is possible to install your extension using composer require
See Publish an Extension for more information on how to publish an extension and check out the FAQ as well.
Advantages:
- More visibility for your extension
- The community can vote for your extension
- Donate link (optional)
- Link to the documentation (optional)
- Link to the source code (optional)
The TYPO3 community currently uses GitHub, GitLab and Atlassian Bitbucket to host the Git repository of their extensions.
Just add a repository to your workspace. Typically, the extension key is used for the repository name, but that is not necessary.
Advantages:
- More visibility for your extension
- Contributors can add issues or pull requests
- Render the documentation on docs.typo3.org (see next step) by adding a webhook
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 h2document:migrate
except for step 4 (request redirects) which is not necessary for new documentation.
Advantages:
- Your extension will be rendered on docs.typo3.org
- More visibility for your extension
- The documentation link will automatically be added if your extension is registered on extensions.typo3.org (TER).