OpenStack DocumentationProjects and ProcessDocumentation in the Open

®

What is OpenStack?

• OpenStack is a global collaboration of developers and cloud computing technologists producing the open standard cloud computing platform for both public and private clouds.

• The project aims to deliver solutions for all types of clouds by being simple to implement, massively scalable, and feature rich.

• The technology consists of a series of interrelated projects delivering various components for a cloud infrastructure solution.

®

OpenStack Principles

• Open development model – Apache 2.0 license, Contributors agreement.

• Open design process – Design Summit every six months.

• Open community – Resources dedicated to active developer and user community. Open processes required.

®

OpenStack Projects - Core

• Compute – Nova• Storage - Swift

• It’s OSSM (awesome)– On-demand: the server is already setup and ready to be deployed– Self-service: customer chooses what they want, when they want it– Scalable: customer can choose how much they want and ramp up if

necessary – Measureable: there's metering/reporting so you know you are getting what

you pay for

®

OpenStack Projects - Core

• Identity service - Keystone

• Image service - Glance

• OpenStack Dashboard - Horizon

• Network Connectivity service - Quantum

®

OpenStack Release Process

• Planning– Design Summits– Blueprints

• Implementation

• QA

• Release – Release milestones– Release Candidate Freeze– Feature Freeze Exception– Release naming– Release numbering

®

OpenStack Documentation Processes – Design Summit• Blueprints and discussion at Design Summit

• Implementation of blueprints – example, api.openstack.org

®

OpenStack Documentation Processes –Launchpad• Bug logging

• Bug triaging

• Bug assigning

• Core documentation team – monthly meetings

®

OpenStack Documentation Processes –Github and GitGithub repositories store admin guides and

API guides

openstack/openstack-manuals

Contains:– Compute admin manual– Storage admin manual– API Quick Start– Compute API Programmer’s Guide– Install guide for Compute– Network connectivity (Quantum) admin

manual

One dev guide each (plus WADLs):

openstack/object-api

openstack/compute-api

openstack/netconn-api

openstack/identity-api

openstack/image-api

®

OpenStack Documentation Processes – Gerrit and Jenkins• Automated publishing process with Jenkins jobs and Gerrit reviews

®

Where Documentation Processes Diverge from Development Processes• Does not track milestone releases yet• Translation not yet set up

®

OpenStack Governance

Project Policy Board• http://wiki.openstack.org/Governance/PPB • The Project Policy Board is a governance body for OpenStack projects. The Board consists of a

mixture of elected and appointed members.

Elections• http://wiki.openstack.org/Governance/Model • Under the OpenStack Governance Model biannual elections will be held for a variety of

positions. Each project will elect a Project Technical Lead every six months.

Summary: Meritocracy

®

Questions with Answers

How can I get on the openstack-core-docs team?Do lots of reviews at http://review.openstack.org for the openstack-manuals project. Triage bugs and log doc bugs at http://bugs.launchpad.net/openstack-manuals. We’ll discuss on the openstack-docs-core mailing list and then invite you.

How should I find doc work that needs to be done on a particular project?

Refer to http://bugs.launchpad.net/openstack-manuals and look for Wishlist for tasks, or any doc bug can be picked up as a work item. We also track few blueprints which may need someone to work on, though doc bugs are probably the best first place to look

How do I know who should do reviews of my document changes?

Anne Gentle, the doc coordinator, or anyone on the openstack-doc-core team can help you identify reviewers, or you can also check the doc bug and ask the reporter to review the changes by adding their name to the reviewers list.