kgess-mirror/openstack-barbican-specs
1
0
Fork 0
mirror of https://opendev.org/openstack/barbican-specs.git synced 2026-01-11 19:56:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Blueprints for the barbican project
164 commits 1 branch 0 tags 2.9 MiB
Find a file
Exact
niuke 7f6525a0bb setup.cfg: Replace dashes with underscores 
Setuptools v54.1.0 introduces a warning that the use of dash-separated
options in 'setup.cfg' will not be supported in a future version [1].
Get ahead of the issue by replacing the dashes with underscores. Without
this, we see 'UserWarning' messages like the following on new enough
versions of setuptools:

  UserWarning: Usage of dash-separated 'description-file' will not be
  supported in future versions. Please use the underscore name
  'description_file' instead

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Change-Id: I7ac3d0bd3eabbf1c23a5060b9f91b8a6c44336be
2023-05-05 13:57:18 +08:00
doc/source remove unicode from code 2021-01-05 17:13:21 +08:00
specs Update the secret consumers spec 2022-09-09 14:12:07 +02:00
.gitignore Ignore some files during running tox 2017-06-15 10:31:42 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:34:04 +00:00
.zuul.yaml import zuul job settings from project-config 2018-09-08 19:28:25 +02:00
LICENSE Add License and README 2014-05-15 14:02:39 -04:00
README.rst Update README and specs/template.rst 2019-05-24 10:32:10 -05:00
requirements.txt Switch to newer openstackdocstheme and reno versions 2020-05-30 16:17:38 +02:00
setup.cfg setup.cfg: Replace dashes with underscores 2023-05-05 13:57:18 +08:00
setup.py First Pass at Doc Build 2014-05-19 20:56:54 -05:00
tox.ini Cleanup py27 support and docs 2020-04-09 21:25:44 +02:00

README.rst 

==================================
OpenStack Barbican Specifications
==================================

.. image:: https://governance.openstack.org/badges/barbican-specs.svg
    :target: https://governance.openstack.org/tc/reference/tags/index.html

This git repository is used to hold approved design specifications for changes
to the Barbican 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>/

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

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
`story in storyboard`__.  Not all approved blueprints will get fully implemented.

.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/barbican-specs

__ Storyboard_

Specifications have to be re-submitted for every release.  The review may be
quick, but even if something was previously approved, it should be re-reviewed
to make sure it still makes sense as written.

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/barbican

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.