[TYPO3-doc] Core documentation status

François Suter fsu-lists at cobweb.ch
Mon Jun 11 21:39:01 CEST 2012


Hi Christian,

> So:
> - How is the current work flow? Is it already possible to push patches
> for the core documentation for the upcoming 6.0?

We are on the verge of committing the migrated manuals to their 
respective repositories. Once this is done, it will be possible to push 
patches to Gerrit. In the meantime, please open issues on Forge, which 
must be done anyway (if not already done).

> - Is there already some documentation documentation? A guide to render
> reST locally, an advise in the git wiki patches for contributers on how
> to submit changes and when (eg. tsref)?

About reST, there are various resources here:

http://wiki.typo3.org/Category:ReST

I'm not sure if it's absolutely up to date, since things are moving fast 
these days.

We don't really have a contribution guide yet. I would suggest the 
following:

- open an issue for documentation whenever a change in the Core would 
require it. This should be done when the Core change is pushed to 
Gerrit, so that documentation is already available for reference.
- when the patch is merged into the Core, the documentation patch should 
be finalized (if needed) and pushed to Gerrit.
- if the Core patch was rejected, the corresponding documentation issue 
should be closed (or the patch abandoned, if it was pushed to Gerrit too 
early).

Does that make sense?

> - Will the core documentation rendering (for the core) be ready for reST
> with release of 6.0?

That is what we aim for.

Cheers

-- 

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


More information about the TYPO3-project-documentation mailing list