[TYPO3-doc] 2012: New year has been released // Versioning documentation

[Martin Bless]

Hello everybody,

welcome back on stage. A new version of instance 'year' has just been
released (r2012) and I hope you all enjoyed the procedure.

I just stumpled upon some ideas and opinions on how to version
documentation. And since I'm afraid I might forget the sources I think
I better put them here. And of course you may be interested as well.

Dear Diary, please take care of this notes:

In [1] the question is being raised: " How to manage many versions?"
(of documentation)

In [2] Max Battcher gives an interesting answer and points to [3]
readthedocs.org: "... A good example of these best practices would be
to wander around readthedocs.org, which is trying to be something of a
best-practices host for Sphinx documentation ..."

*"Best practices"* - what seducing words. And even better: At [3]
you're free to register and import your own docs. "Read the Docs hosts
documentation for the open source community" - that's what they say.

What I want to keep in my mind: The default Sphinx theme like in [4]
works well but is not my favourite choice in terms of taste. OTH, the
read-the-docs theme like in [5] looks like a good - neutral - starting
point to me although its probably only a slightly modifed version.

[6] Hhm, "[View Docs] [Builds]  [PDF]  [Manpage]  [Epub]" - wished we
had that already.

And of course: read-the-docs ist OpenSource as well. And /one/ target
group is described as "All of the RTD code is open source, so you can
run your own instance. Presumably in an internal install inside your
company, or something." [7]

End of diary entry. See you tomorrow ...

Martin


[1] http://article.gmane.org/gmane.comp.python.sphinx.devel/5609/
[2]
http://thread.gmane.org/gmane.comp.python.sphinx.devel/5601/focus=5609
[3] http://readthedocs.org/
[4] http://docs.python.org/whatsnew/2.7.html
[5] http://read-the-docs.readthedocs.org/en/latest/index.html
[6] http://readthedocs.org/projects/read-the-docs/
[7] http://read-the-docs.readthedocs.org/en/latest/index.html

-- 
http://mbless.de