[openstack-dev] Question on component docs

Joshua Harlow harlowja at yahoo-inc.com
Fri Aug 31 17:25:36 UTC 2012


Hi all,

I was wondering if we could figure out a way to standardize on each project having a set of docs in certain locations that would be used for the following.


 1.  Knowing what the changes were for a given release (ie a 'changelog' file)
 2.  Possibly a 'migration' file that would explain how to migrate from version N-1
 3.  Docs on how to install/setup/configure for the current code (kept up to date locally, not in devstack…)

Right now it seems like some of these are in rst (for docs.openstack.org), some are in devstack/rst (the nitty gritty about how to install), some are nonexistent (ie the changelog?). It would seem like each project should have the same set of files in the same locations for all 3 of these without having to refer to X other projects (devstack, the docs pages…).

What do people think?
Is something like this feasible, desired (it'd be nice for me to not have to look at devstack to know how stuff is installed)?
Thoughts?

-Josh

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20120831/cea13911/attachment-0001.html>


More information about the OpenStack-dev mailing list