OpenStack Neutron (virtual network service)

Quantum Development Documentation

Reported by Gary Kotton on 2012-05-22
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
High
Gary Kotton

Bug Description

The source documentation lacks the following:
1. Developers documentation (currently just a link to wiki)
2. Installation guides
3. Start up and configuration guides
4. Detailed documentation and support of features

yong sheng gong (gongysh) wrote :

nova's doc resides on http://nova.openstack.org and source is under nova project's doc dir, built by sphinx. So for us to fix this bug, we first need to setup a site like nova.openstack.org, and then have auto job to run the doc build under our quantum's doc to update the doc site. Of course we need reorg the doc dir too. With all this framework ready, we can populate more document into this doc site.

Is there any one who can point out how to set up the framework ( site, and the auto job)?

Hi,
You are correct. We just need to create the web page
quantum.openstack.org. The build builds the actual pages.
The bug is for adding additional documentation.
Thanks
Gary

On 05/24/2012 05:36 AM, yong sheng gong wrote:
> nova's doc resides on http://nova.openstack.org and source is under
> nova project's doc dir, built by sphinx. So for us to fix this bug, we
> first need to setup a site like nova.openstack.org, and then have auto
> job to run the doc build under our quantum's doc to update the doc site.
> Of course we need reorg the doc dir too. With all this framework ready,
> we can populate more document into this doc site.
>
> Is there any one who can point out how to set up the framework ( site,
> and the auto job)?
>

Gary Kotton (garyk) wrote :

Sorry, missed the point at the end. I understood from Dan that he will
ask Monty to do this. No idea who Monty is :)

On 05/24/2012 05:36 AM, yong sheng gong wrote:
> nova's doc resides on http://nova.openstack.org and source is under
> nova project's doc dir, built by sphinx. So for us to fix this bug, we
> first need to setup a site like nova.openstack.org, and then have auto
> job to run the doc build under our quantum's doc to update the doc site.
> Of course we need reorg the doc dir too. With all this framework ready,
> we can populate more document into this doc site.
>
> Is there any one who can point out how to set up the framework ( site,
> and the auto job)?

dan wendlandt (danwent) wrote :

We'll close this as http://quantum.openstack.org/ is now up.

We should file bugs on more specific areas where content is needed.

Changed in quantum:
status: New → Fix Released
status: Fix Released → Fix Committed
milestone: none → folsom-2
assignee: nobody → Gary Kotton (garyk)
Changed in quantum:
importance: Undecided → High
Thierry Carrez (ttx) on 2012-07-04
Changed in quantum:
status: Fix Committed → Fix Released
Thierry Carrez (ttx) on 2012-09-27
Changed in quantum:
milestone: folsom-2 → 2012.2
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers