On Thu, Mar 22, 2012 at 2:20 AM, Gary Kotton <gkot...@redhat.com> wrote:
> Hi, > I am Gary from Red Hat. I though that a good place to start with the > Quantum project would be to address the documentation. In particular I was > thinking about adding man pages so that users who download the packages > would be able to receive a little additional help. Should I open a > blueprint for this? > Great Gary! We definitely need more people contributing to the documentation. Currently, the main user-facing documentation is the Quantum Administrator Guide: http://docs.openstack.org/incubation/openstack-network/admin/content/index.html This is creating using docbook, and is hosted as part of the main openstack-manuals project: https://github.com/openstack/openstack-manuals/blob/master/doc/src/docbkx/openstack-network-connectivity-admin/quantum-admin-guide.xml. Reviews are handled using git-review and gerrit, just like openstack code. Currently, this is the only documentation that we commit to updating regularly. I think man pages would be useful as well, as long as we can commit to maintaining them moving forward. This could be a challenge, given that I expect the quantum client CLI in particular to change a lot in the next release cycle (there are few things worse than badly out-of-date documentation). Either way, great to have you on board and contributing :) Dan > Thanks > Gary > > -- > Mailing list: > https://launchpad.net/~**netstack<https://launchpad.net/~netstack> > Post to : netstack@lists.launchpad.net > Unsubscribe : > https://launchpad.net/~**netstack<https://launchpad.net/~netstack> > More help : > https://help.launchpad.net/**ListHelp<https://help.launchpad.net/ListHelp> > -- ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Dan Wendlandt Nicira Networks: www.nicira.com twitter: danwendlandt ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Mailing list: https://launchpad.net/~netstack Post to : netstack@lists.launchpad.net Unsubscribe : https://launchpad.net/~netstack More help : https://help.launchpad.net/ListHelp
