opendev/infra-specs
Code Issues Proposed changes
e0ee9b1955
infra-specs/doc/source
History
Anita Kuno 3f200c02d3 Adds an implemented directory 
Right now infra-specs doesn't have a way to indicate which specs
have been implemented. This patch adds a directory entitled
implemented to gather completed specs. One spec which is known
to be implemented is moved into this directory.

The documentation index file has been edited so that the
documentation reflects this change.

Change-Id: I69be74b7469030abcbaf1c0e341b38e5053500c5
2014-12-10 15:44:29 -07:00
..
conf.py Use the current date for the copyright statement 2014-09-10 16:04:37 -04:00
contributing.rst Initial commit 2014-06-10 16:25:32 -07:00
index.rst Adds an implemented directory 2014-12-10 15:44:29 -07:00
readme.rst Initial commit 2014-06-10 16:25:32 -07:00
specs Initial commit 2014-06-10 16:25:32 -07:00
template.rst Initial commit 2014-06-10 16:25:32 -07:00

readme.rst

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.

Repository Structure

The expected structure of the respository is as follows:

specs/
    implemented/

Expected Work Flow

  1. Create a story in StoryBoard with a task affecting the infra-specs project.
  2. Propose review to infra-specs repository (ensure Story:<story number> is in the commit message).
  3. Leave a comment with the Gerrit address of the specification.
  4. Bring forward the proposed item to the infra meeting for summary.
  5. Review happens on proposal by infra-core members and others.
  6. Iterate until review is Approved or Rejected.

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.

Learn As We Go

This is a new way of attempting things, so we're going to be low in process to begin with to figure out where we go from here. Expect some early flexibility in evolving this effort over time.