Open Stack

Sean like. Thanks!

~sean

On Jul 24, 2013, at 12:22, "Anne Gentle" <anne at openstack.org<mailto:anne at openstack.org>> wrote:

Hi all,
Thanks for the reviews so far! This is what I plan to send in 2 hours to the openstack-dev mailing list. Please let me know any additional comments.
Thanks,
Anne

Program Name: OpenStack Documentation
PTL: Anne Gentle
Mission Statement: Provide documentation for core OpenStack projects to promote OpenStack. Develop and maintain tools and processes to ensure quality, accurate documentation. Treat documentation like OpenStack code.

Details: Documentation is an essential effort to meet the goals of the OpenStack mission. We collaborate tightly with development and maintain open tools and processes like OpenStack development. We review each other's patches, continuously publish, track doc bugs and monitor code patches for doc impact. We provide documentation for installation and system administration of OpenStack clouds at http://docs.openstack.org. We provide API documentation for cloud consumers at http://api.openstack.org.

The docs-core team consists of about 20 members who review documentation patches, log and triage doc bugs, moderate comments on the documentation, write documentation, provide tooling for automation and publication, and maintain search and navigation for the docs.openstack.org<http://docs.openstack.org> and api.openstack.org<http://api.openstack.org> sites. We also support community-centric book sprints, intensive documentation efforts focused on a single deliverable.

We offer a framework and tools for creating and maintaining documentation for OpenStack user roles as defined by the User Committee [1]:

- A consumer who is submitting work, storing data or interacting with an OpenStack cloud
- An operator who is running a public or private openstack cloud
- An ecosystem partner who is developing solutions such as software and services around OpenStack. This corresponds to the “built for openstack” trademark requirements.
- A distribution provider or appliance vendor that is providing packaged solutions and support of OpenStack

Expected deliverables and repositories:
The OpenStack Documentation program maintains and governs these repositories:
openstack/openstack-manuals
openstack/api-site
openstack/operations-guide

These repositories are co-governed with project core and docs-core having approval permissions:
openstack/compute-api
openstack/object-api
openstack/netconn-api
openstack/image-api
openstack/identity-api
openstack/volume-api

Note: One integrated project repos co-governed with project core and docs-core:
database-api

As an example, here is a general mapping for a project's documentation, such as the Images project, Glance:
glance/doc/source/ should contain information for contributors to the Glance project itself.
openstack/openstack-manuals/ contains installation and administration information.
openstack/image-api/ contains API specifications.
openstack/api-site/ contains API reference information only.

Since we cannot govern all documentation equally with the resources available, our focus is core first, with collaborative efforts to provide coaching and processes to complete documentation for OpenStack core and integrated projects.

Thanks for reading this far -- input and questions welcomed.
Anne

1. https://docs.google.com/document/d/1yD8TfqUik2dt5xo_jMVHMl7tw9oIJnEndLK8YqEToyo/edit

_______________________________________________
Openstack-docs mailing list
Openstack-docs at lists.openstack.org<mailto:Openstack-docs at lists.openstack.org>
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130724/a4c7345a/attachment.html>