@@ -23,6 +23,74 @@ and documentation for
2323:ref: `System Extensions <t3docs:System-Extensions >`
2424is maintained in the Core.
2525
26+ .. _adding-documentation-quickstart :
27+
28+ Quickstart to contribute documentation
29+ ======================================
30+
31+ To work on the Core documentation of TYPO3, you need to work with the main TYPO3
32+ mono-repository. You can **not ** contribute Documentation patches on single read-only
33+ repositories like `https://github.com/typo3-cms/felogin `__ through the GitHub interface!
34+
35+ You can, however, use the GitHub interface and contribute to `https://github.com/TYPO3/typo3/tree/main/typo3/sysext/felogin `__.
36+ Submitting a GitHub PR will result in a GitHub Action workflow that closes your
37+ PR, transfers it to forge, transfers it to gerrit, and link them to each other. That workflow
38+ can be prone to errors though, especially if a branch other than `main ` is involved.
39+
40+ So, if possible you could better follow the :ref: `Quickstart <quickstart >` guide to
41+ set up a Core contribution installation. A lot can be left out,
42+ as you do not necessarily even need a TYPO3 instance running when you only want to contribute
43+ documentation.
44+
45+ The minimal steps to contribute documentation "the right way" (and to allow you to properly
46+ participate in our review workflow) is this:
47+
48+ .. rst-class :: bignums-xxl
49+
50+ 1. Prerequisites
51+
52+ From the :ref: `Quickstart Prerequisites <quickstart-prerequisites >` you need:
53+
54+ 1. Operating System
55+ 2. GIT client
56+ 3. SSH client + keys
57+ 4. Optional Bonus: Docker (to render documentation), a suitable Text-Editor
58+
59+ 2. Set-up accounts
60+
61+ You need all of the :ref: `Quickstart Accounts <quickstart-accounts >` (My TYPO3, GitHub, Gerrit, Forge)
62+
63+ 3. Set-up GIT
64+
65+ Set up and clone the TYPO3 mono-repository as described in :ref: `Quickstart GIT <quickstart-git >`.
66+
67+ Note: the steps :ref: `<quickstart-ddev >` and :ref: `<quickstart-typo3 >` are not needed for Documentation-only use.
68+
69+ 4. Start documenting
70+
71+ Now you can start editing files in, for example, :file: `typo3/sysext/felogin/Documentation/Index.rst ` and
72+ when you are done, you can render the documentation (see :ref: `<render-extension >`) to verify
73+ the look of your changes.
74+
75+ 5. Create issue
76+
77+ Once you feel comfortable and happy with your patch, you go to `create an issue on Forge
78+ <https://forge.typo3.org/projects/typo3cms-core/issues/new> `__. Choose the category `Documentation `
79+ and enter an appropriate description like:
80+
81+ **Tracker **: Task
82+
83+ **Subject **: Add example for EXT:felogin RedirectLoginHandler
84+
85+ **Description **: (Describe what kind of documentation changes you made. Mention to which TYPO3 version it applies)
86+
87+ 6. Submit patch
88+
89+ Now follow the steps outlined in :ref: `<quickstart-patch >`, and refer to the Documentation files
90+ you edited, instead of the PHP files given as examples there. This will then submit your patch
91+ to our Gerrit review instance.
92+
93+
2694.. index ::
2795 single: Documentation Contribution Workflow; Add Changelog
2896 single: Changelog; Add Entries
@@ -69,6 +137,31 @@ installed you can try out the rendering of the changelog locally:
69137 docker run --rm --pull always -v $( pwd) :/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
70138 xdg-open " Documentation-GENERATED-temp/Index.html"
71139
140+ .. _render-extension :
141+
142+ Render any system documentation locally
143+ ---------------------------------------
144+
145+ As above, you can render any extension locally, too. You need to change the directory to the extension
146+ directory you want to render. For `EXT:felogin ` that would be:
147+
148+ .. tabs ::
149+
150+ .. group-tab :: Docker
151+
152+ .. code-block :: bash
153+
154+ cd typo3/sysext/felogin
155+ docker run --rm --pull always -v $( pwd) :/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
156+ xdg-open " Documentation-GENERATED-temp/Index.html"
157+
158+ .. group-tab :: Podman
159+
160+ .. code-block :: bash
161+
162+ cd typo3/sysext/felogin
163+ docker run --rm --pull always -v $( pwd) :/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation
164+ xdg-open " Documentation-GENERATED-temp/Index.html"
72165
73166 .. index ::
74167 single: Tools; reST File Generator
0 commit comments