[TYPO3-core] Updated Core documentation workflow

François Suter fsu-lists at cobweb.ch
Sun May 19 15:02:04 CEST 2013

Hi all,

As you (should) know there is a process related to documentation for 
those Core changes that require it. This was apparently discussed during 
the recent ACME and Ernesto brought this as a topic in the latest 
Documentation Team meeting.

There were mostly two things:

1) more recent contributors might not be aware of the workflow at all.

2) the workflow included submitting a Git/Gerrit patch to the relevant 
Core manual(s) and this seemed a bit too extreme.

We agreed to drop this requirement. As such I have revised the workflow 
documentation (and restructured it a bit too, as it was spread over 
several wiki pages and rather inconsistent). Please find the revised 
workflow here:


And don't forget that this is required, otherwise there's little hope 
for the Documentation Team to be ready in time with updated 
documentation when a new TYPO3 CMS release comes out.

On our (Doc Team) side, what we will try to improve is to have target 
versions and Git branches ready (for older versions), so that 
documentation patches can be submitted as soon as possible during a 
release's development. Now that we have a version switching menu on 
docs.typo3.org, we will also try to introduce a way to mark the latest 
stable version, so that "master" versions of the manuals can be seen at 
any time, but normal users see by default the documentation 
corresponding to latest stable.

BTW Martin is currently checking with the Server Admin team to have a 
Gerrit hook triggering a rendering of the documentation whenever a 
change is merged, so manuals should be up to date at any time (this is 
already working, but some fine-tuning is still needed).


Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch

More information about the TYPO3-team-core mailing list