630ca71e3c
Specs are not ordered currently, and every rst file inside the specs folder is included in the TOC tree, but manually. This is a problem as: - the current readability of the specs was reduced due to inclusion of non-specs files - the process of writing a spec was more tedious, due to the update of the specs/index.rst. This fixes it by removing the extra files included by mistake in the middle of the specs (the template for spec writing, and the specs purpose/process), and automatically load all the remaining files using a glob. The content of the files removed is not lost: The template was simply renamed COPYME to clearly state a spec writer should copy the file (and will understand it needs to be named .rst) with the other files present. The specs process/purpose is now part of the main page of specs, which therefore doesn't need extra including. Change-Id: I8aa15c8a8f2d8b3ffb764c3fb2411eb27477d0b6
1.5 KiB
Project Specifications
Specifications in this repository represent a consensus on the topics covered within. They should be considered a mandate on the path forward with regards to the content on which they are drafted.
Here is a list of the current specs:
Specifications Purpose
A specification should precede any broad-reaching technical changes or proposals to OpenStack-Helm. Examples of changes requiring a specification include: a standard format to the values.yaml files, multiple backend support for neutron, and the approach for logging and monitoring in OpenStack-Helm. Some additional features will not need an accompanying specification, but may be tied back to an existing specification. An example of this would be introducing a service in OpenStack-Helm that could be included under the scope of a specification already drafted and approved.
Specifications Process
Before drafting a specification, a blueprint should be filed in Storyboard along with any dependencies the blueprint requires. Once the blueprint has been registered, submit the specification as a patch set to the specs/ directory using the supplied template.
More information about the blueprint + specification lifecycle can be found here.