openstack
/
heat-specs
Code Issues Proposed changes
OpenStack Orchestration (Heat) Specifications
348 Commits 1 Branch 0 Tags 6.1 MiB
Python 100%
Go to file
Ghanshyam Mann a74eeba323 [ussuri][goal] Update contributor documentation 
This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38524
Change-Id: Ibca3f0d02bd5740b1502b32c9bc45fee75f956a6
 		2021-05-14 15:58:07 -05:00
doc/source Switch to newer openstackdocstheme version 2020-05-30 17:08:47 +02:00
specs Cleanup docs building 2020-06-04 10:15:51 +02:00
tests Fix rocky template 2018-08-29 15:51:49 -04:00
.gitignore Added AUTHORS and ChangeLog to .gitignore 2015-09-25 15:26:18 -04:00
.gitreview OpenDev Migration Patch 2019-04-19 19:33:26 +00:00
.testr.conf Add some tests to validate specs 2015-04-21 16:05:03 +05:30
.zuul.yaml Cleanup docs building 2020-06-04 10:15:51 +02:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2021-05-14 15:58:07 -05:00
LICENSE Added cookiecutter specs framework 2014-05-27 12:47:57 -07:00
MANIFEST.in Added cookiecutter specs framework 2014-05-27 12:47:57 -07:00
README.rst Update README.rst 2016-07-25 05:33:46 +00:00
requirements.txt Cleanup docs building 2020-06-04 10:15:51 +02:00
setup.cfg Cleanup docs building 2020-06-04 10:15:51 +02:00
setup.py Update setuptools setup_requires 2015-08-05 09:27:27 +08:00
test-requirements.txt Use testscenarios lib for testing per-release 2016-01-12 08:32:36 +00:00
tox.ini Cleanup docs building 2020-06-04 10:15:51 +02:00

README.rst

OpenStack Heat Specifications

This git repository is used to hold approved design specifications for additions to the heat project. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the code itself.

The layout of this repository is:

specs/<release>/

Specifications are proposed for a given release by adding them to the specs/<release> directory and posting it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in launchpad. Not all approved blueprints will get fully implemented.

You can find an example spec in specs/template.rst.

There is a sub-directory specs/<release>/backlog to store all specs that had been approved but are not implemented in a specific release.

Movement of specs to the backlog would be done in a batch at the end of a release cycle.

Prior to the Juno development cycle, this repository was not used for spec reviews. Reviews prior to Juno were completed entirely through Launchpad blueprints:

http://blueprints.launchpad.net/heat

Please note, Launchpad blueprints are still used for tracking the current status of blueprints. For more information, see:

https://wiki.openstack.org/wiki/Blueprints

For more information about working with gerrit, see:

http://docs.openstack.org/infra/manual/developers.html#development-workflow

To validate that the specification is syntactically correct (i.e. get more confidence in the Jenkins result), please execute the following command:

$ tox

After running tox, the documentation will be available for viewing in HTML format in the doc/build/ directory. Please do not checkin the generated HTML files as a part of your commit.