cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jessica Tomechak <jessica.tomec...@gmail.com>
Subject [DOCS] Questions on publishing and updating documentation
Date Thu, 21 Feb 2013 01:49:31 GMT
There's a question of how to publish docs, and how often to update docs for
previous releases, if at all.

Publishing new docs:
As far as I know, docs aren't auto-uploaded to the doc site [1] every time
a new doc build results in new output. I think there's a manual upload, and
I don't know whether it's documented. I wish that I had the steps and
permissions, because I would like to be able to push  doc fixes when it's
appropriate. At the least, more than one person should have the know-how.
If some subset of people are already "maintainers" on this process, let's
add that info somewhere in the Doc Writers part of the project wiki.[2]

Updating old docs:
My practice with CloudStack docs pre-Apache was always to propagate fixes
backwards to whatever releases they affected, put a new "Updated On:" date
on the title page, and republish. I don't know whether we want to be that
exhaustive about backwards-maintaining published docs. It's possible we
want to do this only for real "showstopper" errors in the docs...like, say,
incorrect installation instructions or security holes. Or maybe we do want
true real-time updates to all docs in all versions.

So far in the life of ACS, it seems we have frozen the docs for release
4.0.0 and have not updated them since they were first posted on
http://incubator.apache.org/cloudstack/docs/. (I am not sure, because I
don't see an Updated: timestamp.) If any doc bug-fixes have been checked in
to a 4.0.0 branch since then, it would be great to rebuild and upload those
docs again.

It does not appear we published updated docs for 4.0.1. So that brings up
another question. Do we want to update docs for every minor release? Or
just for moves like 4.0 to 4.1?

[1] http://incubator.apache.org/cloudstack/docs
[2]
https://cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+Team

Jessica T.

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message