From 13e1a60d7795da47ff7ad93d5e0e77f7c4307797 Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Mon, 29 Jan 2024 21:40:51 +0100 Subject: [PATCH] [TASK] Overhaul and shorten "Contribute to system extensions" It is mainly explained in the Core contribution guide --- .../ContributeToSystemExtension.rst | 54 ++++++++----------- 1 file changed, 23 insertions(+), 31 deletions(-) diff --git a/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst b/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst index 1fdfea40..ee8b99cd 100644 --- a/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst +++ b/Documentation/WritingDocForExtension/ContributeToSystemExtension.rst @@ -1,39 +1,31 @@ -.. include:: /Includes.rst.txt -.. highlight:: rst -.. index:: pair: Documentation; System extensions -.. _contribute-to-system-extension: +.. include:: /Includes.rst.txt +.. highlight:: rst +.. index:: pair: Documentation; System extensions +.. _contribute-to-system-extension: =============================== Contribute to system extensions =============================== -The documentation for system extensions is maintained inside the TYPO3 -source code, so the contribution workflow is a little different. - -* When it comes to documentation that is contained within the - core (like system extension documentation and changelog), you would - use Forge to report **issues**, using the category "Documentation": - https://forge.typo3.org/projects/typo3cms-core/issues -* The :ref:`t3contribute:start` explains the **contribution workflow** for the core. - For making a change to the documentation in the core, you would use the - workflow explained in that guide (using Git and pushing to Gerrit). -* You can also test the change by :ref:`rendering locally ` - as in any documentation patch, because all documentation uses a common - format and :ref:`file structure ` - and can be rendered with the same Docker container. - -.. tip:: - - There is an easy shortcut for minor changes: You can use - the :ref:`Edit on GitHub method ` for - minor changes to system extensions documentation and the changelog. Under the hood, - a patch will get created and pushed to Gerrit and you will find a - comment in your pull request with information about where to find your patch - on Gerrit. - - .. image:: /Images/github-gerrit.png - :class: with-shadow - :target: https://github.com/typo3/typo3/pull/172#issuecomment-494721296 +The documentation for system extensions is maintained in the TYPO3 Core mono +repository on the Gerrit instance https://review.typo3.org/. + +Follow the general :ref:`Core contribution workflow `. + +Changes to the documentation of system extensions can be :ref:`rendered locally +`. + +.. tip:: + + There is an easy shortcut for minor changes: You can use + the :ref:`Edit on GitHub method ` for + minor changes to system extensions documentation and the changelog. + A patch will get created and pushed to Gerrit. A comment to your pull + request on GitHub links you to the patch on gerrit + + .. image:: /Images/github-gerrit.png + :class: with-shadow + :target: https://github.com/typo3/typo3/pull/172#issuecomment-494721296 See `System Extensions `__ for a list of system extension documentation.