[Openstack] New Launchpad project for API docs, new Github repo

Anne Gentle anne at openstack.org
Mon Oct 15 18:26:00 UTC 2012


Hi all -

In order to offer more fine-grained understanding of needs for API
docs especially user docs, I've split the openstack-manuals project
out to have an openstack-api-site project in Launchpad so we can track
bugs. We'll be migrating the openstack-manuals bugs tagged with
api-site, compute-api, and so on, to the openstack-api-site project.
The idea is to separate API doc bug tracking from the admin manuals.
[1]

I'm also working on bringing API docs into a new Github repo, at
http://github.com/openstack/api-site, for which the above project
tracks bugs. The guides that are moving into this site are: API Quick
Start [2], Programming OpenStack Compute API with Shell and Python
[3], API Complete Reference [4].

You can also use the openstack-api-site project to track bugs against
the API specs housed in the following repositories:
compute-api
netconn-api
object-api
identity-api
image-api
volume-api

Use a tag on the bug that corresponds to the repo name in the above list.

I'm tracking the CI work here:
https://etherpad.openstack.org/api-site-structure which is all the
Jenkins/Zuul work that still needs done so that this new repository
can publish.

I welcome any questions about our new doc bug tracking overlord.
Thanks to Tom Fifield for all the doc bug triaging so far that helps
us identify this need.
Anne

[1] https://launchpad.net/openstack-api-site
[2] http://docs.openstack.org/api/quick-start/content/
[3] http://docs.openstack.org/api/openstack-compute/programmer/content/
[4] http://api.openstack.org




More information about the Openstack mailing list