Tags are applied to deliverables, or teams
Clarify confusing language in tag descriptions around "projects". Tags are either applied to project deliverables, or to the project team. Also move status:maintenance-mode to the "Team tags" section in the index since that is how it is currently applied. Change-Id: I0b63b3d65be64c572f2247dc9070245e78790db4
This commit is contained in:
parent
9ed4068501
commit
75fed0dd31
reference
tag-template.rst
tags
assert_follows-standard-deprecation.rstassert_supports-accessible-upgrade.rstassert_supports-api-interoperability.rstassert_supports-rolling-upgrade.rstassert_supports-upgrade.rstassert_supports-zero-downtime-upgrade.rstdocs_follows-policy.rstindex.rststarter-kit_compute.rststatus_maintenance-mode.rsttc_approved-release.rstteam_diverse-affiliation.rstteam_single-vendor.rst
@ -29,14 +29,15 @@ proposed-tag-name (should match the tags/proposed-tag-name.rst filename)
|
||||
Introduction paragraph -- a short summary of what this tag will mean.
|
||||
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
As part of the application you need to go through the exercise of applying
|
||||
the proposed tag to at least some subset of the current project list. This
|
||||
the proposed tag to at least some subset of the current deliverables or teams
|
||||
(depending on whether the tag applies to teams or deliverables). This
|
||||
will serve as an example of how the tag should be applied in the real world.
|
||||
You may also submit (as a subsequent change) the corresponding governance
|
||||
change to immediately apply the proposed tag to projects.
|
||||
change to immediately apply the proposed tag to deliverables or teams.
|
||||
|
||||
.. tagged-projects:: <tag name>
|
||||
|
||||
|
@ -19,8 +19,8 @@ The "assert:follows-standard-deprecation" tag asserts that the project will
|
||||
follow standard feature deprecation rules as described here.
|
||||
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: assert:follows-standard-deprecation
|
||||
|
||||
|
@ -18,8 +18,8 @@ project supporting basic :ref:`upgrade capabilities
|
||||
<tag-assert:supports-upgrade>`, it does so *without disrupting the
|
||||
accessibility of controlled resources.*.
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: assert:supports-accessible-upgrade
|
||||
|
||||
|
@ -19,8 +19,8 @@ The "assert:supports-api-interoperability" tag asserts that the project will
|
||||
follow the API interoperability guidelines and that they will not change (or
|
||||
remove) an API in a way that will break existing users of an API.
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: assert:supports-api-interoperability
|
||||
|
||||
|
@ -18,8 +18,8 @@ features that the project supports.
|
||||
The "assert:supports-rolling-upgrade" tag asserts that the project
|
||||
will support minimal rolling upgrade capabilities.
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: assert:supports-rolling-upgrade
|
||||
|
||||
|
@ -18,8 +18,8 @@ features that the project supports.
|
||||
The "assert:supports-upgrade" tag asserts that the project will
|
||||
support minimal cold (offline) upgrade capabilities.
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: assert:supports-upgrade
|
||||
|
||||
|
@ -18,8 +18,8 @@ project supporting `minimal rolling upgrade capabilities
|
||||
<https://governance.openstack.org/tc/reference/tags/assert_supports-rolling-upgrade.html>`_,
|
||||
it does so *without incurring any disruption to API availability*.
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: assert:supports-zero-downtime-upgrade
|
||||
|
||||
|
@ -16,8 +16,8 @@ practices and policies for review and verification. It does not indicate that
|
||||
the documentation team has taken ownership of producing the documentation for
|
||||
the deliverable.
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: docs:follows-policy
|
||||
|
||||
|
@ -37,6 +37,7 @@ Team Description Tags
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
status_maintenance-mode
|
||||
team_diverse-affiliation
|
||||
team_single-vendor
|
||||
|
||||
@ -62,7 +63,6 @@ project doesn't actually meet the documented criteria.
|
||||
assert_supports-accessible-upgrade
|
||||
assert_supports-rolling-upgrade
|
||||
assert_supports-zero-downtime-upgrade
|
||||
status_maintenance-mode
|
||||
|
||||
Vulnerability Management Tags
|
||||
=============================
|
||||
|
@ -14,9 +14,8 @@ A common starting point for a Compute oriented OpenStack cloud that
|
||||
can be expanded over time to include more of the OpenStack universe.
|
||||
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: starter-kit:compute
|
||||
|
||||
|
@ -24,8 +24,8 @@ a project team is in a period of low activity (which we call
|
||||
'maintenance-mode'). This is accomplished by applying the
|
||||
status:maintenance-mode tag to the project team.
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current teams
|
||||
============================
|
||||
|
||||
.. tagged-projects:: status:maintenance-mode
|
||||
|
||||
|
@ -20,8 +20,8 @@ OpenStack Foundation Board as candidates for trademark use under the
|
||||
OpenStack Foundation trademark policy.
|
||||
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current deliverables
|
||||
===================================
|
||||
|
||||
.. tagged-projects:: tc:approved-release
|
||||
|
||||
|
@ -17,8 +17,8 @@ about the team itself. Another example of a tag that could exist in this
|
||||
category is one that conveys the size of the team that is actively contributing.
|
||||
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current teams
|
||||
============================
|
||||
|
||||
It's worth pointing out that the criteria used for this tag is applied across
|
||||
all git repositories managed by a team.
|
||||
|
@ -17,8 +17,8 @@ This tag exists in the 'team' category, which as the name implies,
|
||||
covers information about the team itself.
|
||||
|
||||
|
||||
Application to current projects
|
||||
===============================
|
||||
Application to current teams
|
||||
============================
|
||||
|
||||
It's worth pointing out that the criteria used for this tag is applied across
|
||||
all git repositories managed by a team.
|
||||
|
Loading…
x
Reference in New Issue
Block a user