x/mogan-specs
Code Issues Proposed changes
Baremetal Compute (Mogan) Specifications
31 Commits 1 Branch 0 Tags 515 KiB
reStructuredText 91.8%
Python 8.2%
master
Go to file
OpenDev Sysadmins eb7e6f2995 OpenDev Migration Patch 
This commit was bulk generated and pushed by the OpenDev sysadmins
as a part of the Git hosting and code review systems migration
detailed in these mailing list posts:

http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003603.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-April/004920.html

Attempts have been made to correct repository namespaces and
hostnames based on simple pattern matching, but it's possible some
were updated incorrectly or missed entirely. Please reach out to us
via the contact information listed at https://opendev.org/ with any
questions you may have.
2019-04-19 19:51:29 +00:00
doc/source Remove pbr warnerrors in favor of sphinx check 2017-06-27 14:41:54 +05:30
specs Add spec folder for stein 2018-09-14 15:04:17 +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 OpenDev Migration Patch 2019-04-19 19:51:29 +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 Fix the typo and replace http with https for doc links 2017-09-06 20:32:35 -07:00
requirements.txt Remove pbr warnerrors in favor of sphinx check 2017-06-27 14:41:54 +05:30
setup.cfg Remove pbr warnerrors in favor of sphinx check 2017-06-27 14:41:54 +05:30
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:

https://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.