[TYPO3-doc] use Git, Gerrit, etc. without publishing parts of a documentation at docs.typo3.org

Xavier Perseguers xavier at typo3.org
Sat Sep 14 12:22:24 CEST 2013


Hi Michael,

> I'm not sure if there's an easy way to avoid this. However maybe
> versions can help. Since a few months now we are able to handle
> different versions of a manual, like you can see for TSref, for example.
> On top of the version numbers there are two special versions, one
> labeled "stable" and one labeled "latest". When people access a given
> manual, they get the stable version by default.
> 
> So I guess this could help you. The current version would be "stable"
> and the new one "latest". So people would not unknowingly stumble on
> incomplete work.

Yes this should be done like that, just as "master" branch is the work
in progress for the next stable version.

This is exactly what we currently have say for TCA:

http://docs.typo3.org/typo3cms/TCAReference/

this is the stable version (no version after the key in URL) and it
shows version 6.1, not upcoming 6.2 which is available under

http://docs.typo3.org/typo3cms/TCAReference/latest/

> That being said, this requires some manual setup which Martin usually
> did, but now he's away to T3SAIL. Maybe Xavier can set it up, I'm not
> sure I know how.

It's totally straightforward for me to do that for any official manual,
if one is not yet configured like that (for various reasons).

So for your use case I would suggest to ensure every stable version has
its own git branch, and that work-in-progress is done on master branch.
On docs.typo3.org I can then ensure that each version gets properly
rendered (I have to create a project skeleton for each version that
should get published, including "master/latest") and then "stable" will
automatically point to the highest, non-"latest" version upon rendering.

Kind regards

-- 
Xavier Perseguers
Release Manager TYPO3 4.6

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org



More information about the TYPO3-project-documentation mailing list