Skip to content

Commit

Permalink
Add information about publishing an extension
Browse files Browse the repository at this point in the history
  • Loading branch information
sypets committed Aug 19, 2019
1 parent addfa99 commit af0eb1b
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 0 deletions.
1 change: 1 addition & 0 deletions Documentation/ExtensionArchitecture/Index.rst
Expand Up @@ -44,4 +44,5 @@ STEPS TOWARDS CREATING AN EXTENSION
CreateNewExtension/Index
CreateNewDistribution/Index
Documentation/Index
PublishExtension/Index
Resources/Index
93 changes: 93 additions & 0 deletions Documentation/ExtensionArchitecture/PublishExtension/Index.rst
@@ -0,0 +1,93 @@
.. include:: ../../Includes.txt


.. _publish-extension:

======================
Publish Your Extension
======================

By publishing an extension, we mean making it publicly available. This may include
all of or just a few of the following:

#. :ref:`Register your extension on Packagist <publish-extension-packagist>`
#. :ref:`Register your extension on extensions.typo3.org <publish-extension-ter>` (TER)
#. Make your :ref:`extension source code available <publish-extension-git>`
on a public Git hoster such as GitHub,
Gitlab or Bitbucket
#. :ref:`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*

.. _publish-extension-packagist:

Publish Your Extension on Packagist
====================================================

This is described well on `Packagist <https://packagist.org/>`__.

Advantages:

* It is possible to install your extension using `composer require`

.. _publish-extension-ter:

Publish Your Extension on TER
====================================================


See `Publish an Extension <https://extensions.typo3.org/faq/publish-an-extension/>`__
for more information on how to publish an extension and check out the
`FAQ <https://extensions.typo3.org/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)


.. _publish-extension-git:

Publish Source Code on a Public Git Hosting Platform
====================================================

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



.. _publish-extension-docs:

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 :file:`composer.json` and push some
changes after you register the webhook.

All the necessary steps are outlined in :ref:`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).

0 comments on commit af0eb1b

Please sign in to comment.