openstack
/
security-specs
Code Issues Proposed changes
RETIRED, OpenStack Security Specifications
17 Commits 1 Branch 0 Tags 384 KiB
Go to file
Flavio Percoco 5f6287c277 Show team and repo badges on README 
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

b'https://gist.github.com/3a0aa3426f3d89447182a1582767600a\n'

Change-Id: Ia3fd28eb0f69fa1ceee200a7420564779de7ff66
 		2016-12-16 06:05:59 +00:00
doc/source Update index file 2016-02-23 19:29:43 +01:00
specs Changed the mikata directory to mitaka. (Correct spelling) 2016-02-23 12:50:45 +00:00
.gitignore Setup Security Specs Repo 2015-07-07 12:08:00 -07:00
.gitreview Added .gitreview 2015-06-30 16:57:11 +00:00
LICENSE Setup Security Specs Repo 2015-07-07 12:08:00 -07:00
README.rst Show team and repo badges on README 2016-12-16 06:05:59 +00:00
requirements.txt Skip docutils 0.13.1 2016-12-16 08:48:56 +09:00
setup.cfg Merge "Changed the home-page link for security-specs" 2016-12-09 05:19:56 +00:00
setup.py Sync with global requirements 2015-07-17 09:12:10 +02:00
tox.ini Setup Security Specs Repo 2015-07-07 12:08:00 -07:00

README.rst

Team and repository tags

image

OpenStack Security Specifications

This git repository is used to hold approved design specifications for additions to the OpenStack Security Projects. Reviews of the specs are done in gerrit, using a similar workflow to how we review and merge changes to the security projects and supporting tools.

The layout of this repository is:

specs/<release>/

You can find an example spec in doc/source/specs/template.rst. Fill it in with the details of a new blueprint for documentation.

For security projects, blueprints are required for larger, coordinated projects but not for small fixes. It's a judgement call for whether you need a spec, so feel free to ask in the #openstack-security IRC channel or on the openstack-security mailing list.

To propose a specification for a release-specific project, add a new file to the specs/<release> directory and post it for review. The implementation status of a blueprint for a given release can be found by looking at the blueprint in Launchpad (and the spec links to Launchpad).

Please realize that not all approved blueprints will get fully implemented.

Security blueprints are being introduced with the Liberty development cycle using this repository.

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 check in the generated HTML files as a part of your commit.

The files are published at http://specs.openstack.org/openstack/security-specs.

The git repository is located at http://git.openstack.org/cgit/openstack/security-specs/.