infra-specs/README.rst
James E. Blair c43e50b641 Add priority efforts section
Add a section listing priority efforts.  Ensure that there is
exactly one spec listed for each priority effort.  Add stub specs
for efforts which predate the spec process.  Also, publish the
Gerrit search string to see all priority effort changes.

Remove the implemented/ directory so that spec URLs are stable
over time.  We have been linking to them very liberally, so let's
not codify workflow in URLs.

Remove the :glob: options so that specs now need to be listed
individually in the sections in which they should appear.  This
means that spec workflow involves changing the index page rather
than moving files (and URLs).

Change-Id: Ic7f088b7456d66f5ff164dea8504e1c5467bf79d
2015-05-14 15:30:50 -07:00

33 lines
1.2 KiB
ReStructuredText

======================
Infra Specs Repository
======================
This is a git repository for doing design review on enhancements to
the OpenStack Project Infrastructure. This provides an ability to
ensure that everyone has signed off on the approach to solving a
problem early on.
Expected Work Flow
==================
1. Create a story in StoryBoard with a task affecting the
``infra-specs`` project.
2. Propose a change to infra-specs repository (ensure Story:<story
number> is in the commit message).
3. Leave a comment with the Gerrit URL of the specification.
4. Review happens on proposal by infra-core members and others.
5. When ready for final approval, bring forward the proposed item to
the infra meeting.
Once a specification is approved...
1. Update story, copy summary text of specification to there.
2. Leave a comment to the git address of the specification.
Revisiting Specifications
=========================
We don't always get everything right the first time. If we realize we
need to revisit a specification because something changed, either we
now know more, or a new idea came in which we should embrace, we'll
manage this by proposing an update to the specification in question.