[TYPO3-core] New documentation workflow

[Markus Klein]

Hi François,

Thanks for this amazing work.
The announcement is ok for my taste, but I'd also update the Contribution Wiki and add the link to the announcement too.

Kind regards
Markus

> -----Original Message-----
> From: typo3-team-core-bounces at lists.typo3.org [mailto:typo3-team-core-bounces at lists.typo3.org] On Behalf Of François Suter
> Sent: Monday, July 02, 2012 11:49 AM
> To: typo3-team-core at lists.typo3.org
> Subject: Re: [TYPO3-core] New documentation workflow
> 
> Hi all,
> 
> > I would just like to figure out the details here before making an
> > official announcement about it.
> 
> And here's my draft for the announcement, which I would like to validate here before posting it in the official news:
> 
> <quote>
> All the official documentation has been migrated from OpenOffice to ReStructured Text. This means that it is now far easier to
> contribute to a manual, since we are dealing with plain text files. This opens up the possibility to submit documentation patches, just
> like TYPO3 Core patches. Furthermore we also moved away from SVN and each official manual now has its own Git repository and
> Gerrit review queue.
> 
> The Documentation Team and the Core Team thus discussed a new workflow for TYPO3 Core patches that imply documentation
> changes. Our practice currently includes opening a related documentation issue in the relevant manual's bug tracker on Forge. From
> now on it is requested to also submit a documentation patch and push it to Gerrit. The patch must marked with:
> 
> "Depends: ChangeIdComesHere"
> 
> where the Change Id used is the one from the Core patch. Should the Core patch be abandoned, the documentation patch will be
> dropped too.
> 
> Don't worry about the documentation not being too good. The Documentation Team will take care of improving both language and
> content if necessary. The most important thing with this new workflow is to avoid forgetting updates to the documentation and
> having the patches ready up front.
> 
> As we plan to have nightly builds of the ReStructured Text files for the official manuals, it may mean in the near future that we have
> documentation that is always in sync with the source code. I hope you will agree that this is worth the effort.
> </quote>
> 
> Cheers
> 
> --
> 
> Francois Suter
> Cobweb Development Sarl - http://www.cobweb.ch _______________________________________________
> Before posting to this list, please have a look to the posting rules on the following websites:
> 
> http://typo3.org/teams/core/core-mailinglist-rules/
> http://typo3.org/development/bug-fixing/diff-and-patch/
> _______________________________________________
> TYPO3-team-core mailing list
> TYPO3-team-core at lists.typo3.org
> http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-team-core