x/mogan-specs
Code Issues Proposed changes
Baremetal Compute (Mogan) Specifications
7 Commits 1 Branch 0 Tags 515 KiB
reStructuredText 91.8%
Python 8.2%
605c0698c0
Go to file
Zhenguo Niu 605c0698c0 Valence integration 
This specs proposes to integrate with OpenStack Valence to support
compose node on the fly.

Change-Id: Id890263db8a62c7c74a11eedf75c87b148afa546
2017-03-07 16:01:11 +08:00
doc/source Add mogan spec template and tests 2017-01-17 16:47:19 +08:00
specs Valence integration 2017-03-07 16:01:11 +08:00
tests Add mogan spec template and tests 2017-01-17 16:47:19 +08:00
.gitignore Initial import 2017-01-13 12:50:50 +08:00
.gitreview Update .gitreview 2017-01-13 06:11:38 +00:00
.testr.conf Initial import 2017-01-13 12:50:50 +08:00
LICENSE Initial import 2017-01-13 12:50:50 +08:00
README.rst Initial import 2017-01-13 12:50:50 +08:00
requirements.txt Initial import 2017-01-13 12:50:50 +08:00
setup.cfg Initial import 2017-01-13 12:50:50 +08:00
setup.py Initial import 2017-01-13 12:50:50 +08:00
test-requirements.txt Initial import 2017-01-13 12:50:50 +08:00
tox.ini Initial import 2017-01-13 12:50:50 +08:00

README.rst

OpenStack Baremetal Computing Specifications

This git repository is used to hold approved design specifications for additions to the Baremetal Provisioning program, and in particular, the Mogan 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 must follow the template which can be found at specs/template.rst.

blueprints:

http://blueprints.launchpad.net/mogan

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.

To quickly preview just the rst syntax rendering (without Sphinx features) of a single spec file execute the following command:

$ tox -evenv rst2html.py <path-to-your-spec.rst> <path-to-output.html>

and open <path-to-output.html> in your browser. Running full tox is still advised before submitting your patch.