openstack/keystone
Code Issues Proposed changes

Fix contributor doc of keystone

Browse Source 
Since keystone now tracks features as Bugs not
blueprints. This patch updates the same in the
contributor doc.

Change-Id: Ic51205c1403f2085d7f921d3ff9d667cfe3f4c87
This commit is contained in:
Vishakha Agarwal 2019-05-31 19:16:31 +05:30
parent 3d2b293d7e
commit 0a9d7cbec5
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/contributor/api_change_tutorial.rst
View File

@ -28,20 +28,21 @@ In order to follow this tutorial, it is assumed that you have read our
Proposing a change
------------------
You need to create a blueprint, submit a specification against the
`keystone-specs`_ repository and bring it up to discussion with the
`keystone core team`_ for agreement.
You need to create a RFE bug report, submit a specification against the `keystone-specs`_
repository and bring it up to discussion with the `keystone core team`_ for
agreement. Please refer to the `guide for proposing features`_ to learn more about the process.
.. _`guide for proposing features`: https://docs.openstack.org/keystone/latest/contributor/proposing-features.html
.. _`keystone-specs`: https://opendev.org/openstack/keystone-specs/
.. _`keystone core team`: https://review.opendev.org/#/admin/groups/9,members
Create
~~~~~~
#. `Create a blueprint`_ in launchpad;
#. `Create a RFE bug report`_ in launchpad;
#. git clone https://opendev.org/openstack/keystone-specs;
#. cp `specs/template.rst` `specs/backlog/<feature>.rst`;
#. Write the spec based on the template. Ensure the BP link points to the one
#. Write the spec based on the template. Ensure the bug link points to the one
created in step 1;
#. Also update the documentation at `api/v3/identity-api-v3.rst` to reflect the
proposed API changes;
@ -49,7 +50,7 @@ Create
#. Propose agenda items to the `keystone meeting`_, and make sure someone
who understands the subject can attend the meeting to answer questions.
.. _`Create a blueprint`: https://blueprints.launchpad.net/keystone/+addspec
.. _`Create a RFE bug report`: https://bugs.launchpad.net/keystone/+filebug
.. _`template`: https://opendev.org/openstack/keystone-specs/src/branch/master/specs/template.rst
.. _`keystone meeting`: https://wiki.openstack.org/wiki/Meetings/KeystoneMeeting

20
doc/source/contributor/release-notes.rst
View File

@ -72,33 +72,33 @@ providing readers with additional resources:
Changes the token_model to return is_admin_project False if the
attribute is not defined. Returning True for this has the potential to
be dangerous and the given reason for keeping it True was strictly for
backwards compatability.
backwards compatibility.
Release Notes for Features
==========================
Release notes detailing feature work follow the same basic format, but instead
of using the bug number in the name of the release note, use the blueprint slug
used to track the feature work:
Release notes detailing feature work follow the same basic format, since features
are also tracked as bugs.
.. code-block:: bash
$ reno new bp-support-fizzbangs
Created new notes file in releasenotes/notes/bp-support-fizzbangs-d8f6a3d81c2a465f.yaml
$ reno new bug-1652012
Created new notes file in releasenotes/notes/bug-1652012-7c53b9702b10084d.yaml
Just like release notes communicating bug fixes, release notes detailing
feature work must contain a link back to the blueprint. Readers should be able
feature work must contain a link back to the RFE bug report. Readers should be able
to easily discover all patches that implement the feature, as well as find
links to the full specification and documentation. All of this is typically
found in the blueprint registered in Launchpad:
links to the full specification and documentation. The release notes can be added to
the last patch of the feature. All of this is typically found in the RFE bug report
registered in Launchpad:
.. code-block:: yaml
---
features:
- >
[`blueprint support-fizzbangs <https://blueprints.launchpad.net/keystone/+spec/support-fizzbangs>`_]
[`bug 1652012 <https://bugs.launchpad.net/keystone/+bug/1652012>`_]
Keystone now fully supports the usage of fizzbangs.
In the rare case there is a release note that does not pertain to a bug or