Open Stack

As a parallel thread to Anne's doc-specs repo, I propose that we start with the neutron spec template.rst and skeleton.rst found here https://github.com/openstack/neutron-specs/tree/master/specs. We would remove the REST API impact, security, notifications, and performance impact sections. I would modify the Data Model Impact to doc/common docs Impact.

Once we figure out the naming bits from the other thread and the template highlights here, then an Infra patch to create the repo would be the next step.
 


Sean Roberts
Infrastructure Strategy, Yahoo
seanrob at yahoo-inc.com
(925) 980-4729
On Monday, June 23, 2014 10:11 PM, Sean Roberts <seanrob at yahoo-inc.com> wrote:
 


The training-guides team has been seriously looking at using specs as a blueprint development step. After discussing the topic with Anne, we thought discussing having a program wide spec repo was a good idea. 
So I propose the documentation program use the repo Openstack/docs-spec. We would still create a wiki page as the starting point. The design would follow an RST template, so important bits of information do not get missed. 
Here are the steps the training guides project are considering. We were planning just a repo sub-directory, but that would change with the above plan. 
Create a Blueprint
	1. The blueprint is created here https://blueprints.launchpad.net/openstack-training-guides/+addspec, only the name, title, and summary need to be filled out
	2. Submit a spec RST patch based on the template https://github.com/openstack/training-guides/blob/master/specs/template.rst
	3. Gerrit reviews are the debate and refinement
	4. Final RST patch either is rejected or approved
	5. If the RST patch is approved, then it gets merged, the blueprint is approved, and the RST details are manually updated into the blueprint
	6. The blueprint can only be approved for current release
	7. Blueprints not approved or not implemented during a release cycle need the RST patch be resubmitted for the next cycle
~sean
_______________________________________________
Openstack-docs mailing list
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/20140625/96f637f5/attachment-0001.html>