fde3118924
This commit makes changes to the rst files so sphinx will not throw any warnings. The implemented section of the index is removed, we can add it back when a specification is implemented and we move it into that directory. Change-Id: I09f813623c8bdfd830f73592aac6cf57abe87741 |
||
---|---|---|
doc/source | ||
specs | ||
.gitignore | ||
.gitreview | ||
LICENSE | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
template.rst | ||
tox.ini |
README.rst
QA Specs Repository
This is a git repository for doing design review on QA enhancements as part of the OpenStack program. 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
- Create a blueprint stub in
tempest
blueprint repository - Propose review to qa-specs repository (ensure bp:blueprint_name is in the commit message
- Link
Read the full specification
to the gerrit address of the spec - Bring forward the proposed item to the openstack-qa meeting for summary
- Review happens on proposal by qa-core members, and others
- Iterate until review is Approved or Rejected
Once a Review is Approved...
- Update blueprint, Copy summary text of blueprint to there
- Link
Read the full specification
to the git address of the spec - Profit!
Revisiting Specs
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 spec 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.