From 75fed0dd31303d7172a0e25ee22f1986ab99b2fd Mon Sep 17 00:00:00 2001 From: Thierry Carrez Date: Wed, 29 Nov 2017 15:34:39 +0100 Subject: [PATCH] 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 --- reference/tag-template.rst | 9 +++++---- reference/tags/assert_follows-standard-deprecation.rst | 4 ++-- reference/tags/assert_supports-accessible-upgrade.rst | 4 ++-- reference/tags/assert_supports-api-interoperability.rst | 4 ++-- reference/tags/assert_supports-rolling-upgrade.rst | 4 ++-- reference/tags/assert_supports-upgrade.rst | 4 ++-- reference/tags/assert_supports-zero-downtime-upgrade.rst | 4 ++-- reference/tags/docs_follows-policy.rst | 4 ++-- reference/tags/index.rst | 2 +- reference/tags/starter-kit_compute.rst | 5 ++--- reference/tags/status_maintenance-mode.rst | 4 ++-- reference/tags/tc_approved-release.rst | 4 ++-- reference/tags/team_diverse-affiliation.rst | 4 ++-- reference/tags/team_single-vendor.rst | 4 ++-- 14 files changed, 30 insertions(+), 30 deletions(-) diff --git a/reference/tag-template.rst b/reference/tag-template.rst index f5577cba5..c37370255 100644 --- a/reference/tag-template.rst +++ b/reference/tag-template.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:: diff --git a/reference/tags/assert_follows-standard-deprecation.rst b/reference/tags/assert_follows-standard-deprecation.rst index 1615b468e..e30aa11ed 100644 --- a/reference/tags/assert_follows-standard-deprecation.rst +++ b/reference/tags/assert_follows-standard-deprecation.rst @@ -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 diff --git a/reference/tags/assert_supports-accessible-upgrade.rst b/reference/tags/assert_supports-accessible-upgrade.rst index 21cb20e6a..52f25f303 100644 --- a/reference/tags/assert_supports-accessible-upgrade.rst +++ b/reference/tags/assert_supports-accessible-upgrade.rst @@ -18,8 +18,8 @@ project supporting basic :ref:`upgrade capabilities `, it does so *without disrupting the accessibility of controlled resources.*. -Application to current projects -=============================== +Application to current deliverables +=================================== .. tagged-projects:: assert:supports-accessible-upgrade diff --git a/reference/tags/assert_supports-api-interoperability.rst b/reference/tags/assert_supports-api-interoperability.rst index 743cbb0b3..c39b28e11 100644 --- a/reference/tags/assert_supports-api-interoperability.rst +++ b/reference/tags/assert_supports-api-interoperability.rst @@ -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 diff --git a/reference/tags/assert_supports-rolling-upgrade.rst b/reference/tags/assert_supports-rolling-upgrade.rst index 6c6950f21..dc86a2738 100644 --- a/reference/tags/assert_supports-rolling-upgrade.rst +++ b/reference/tags/assert_supports-rolling-upgrade.rst @@ -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 diff --git a/reference/tags/assert_supports-upgrade.rst b/reference/tags/assert_supports-upgrade.rst index f71ddbd48..bef958371 100644 --- a/reference/tags/assert_supports-upgrade.rst +++ b/reference/tags/assert_supports-upgrade.rst @@ -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 diff --git a/reference/tags/assert_supports-zero-downtime-upgrade.rst b/reference/tags/assert_supports-zero-downtime-upgrade.rst index ef36d9e02..aab463e3e 100644 --- a/reference/tags/assert_supports-zero-downtime-upgrade.rst +++ b/reference/tags/assert_supports-zero-downtime-upgrade.rst @@ -18,8 +18,8 @@ project supporting `minimal rolling upgrade capabilities `_, 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 diff --git a/reference/tags/docs_follows-policy.rst b/reference/tags/docs_follows-policy.rst index 9baf62025..b18f4ae05 100644 --- a/reference/tags/docs_follows-policy.rst +++ b/reference/tags/docs_follows-policy.rst @@ -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 diff --git a/reference/tags/index.rst b/reference/tags/index.rst index b53e06203..04677a6c4 100644 --- a/reference/tags/index.rst +++ b/reference/tags/index.rst @@ -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 ============================= diff --git a/reference/tags/starter-kit_compute.rst b/reference/tags/starter-kit_compute.rst index f3e4f10ac..12bc8f0e1 100644 --- a/reference/tags/starter-kit_compute.rst +++ b/reference/tags/starter-kit_compute.rst @@ -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 diff --git a/reference/tags/status_maintenance-mode.rst b/reference/tags/status_maintenance-mode.rst index 211d601d1..c45a4c601 100644 --- a/reference/tags/status_maintenance-mode.rst +++ b/reference/tags/status_maintenance-mode.rst @@ -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 diff --git a/reference/tags/tc_approved-release.rst b/reference/tags/tc_approved-release.rst index bc53195a7..c4167bb56 100644 --- a/reference/tags/tc_approved-release.rst +++ b/reference/tags/tc_approved-release.rst @@ -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 diff --git a/reference/tags/team_diverse-affiliation.rst b/reference/tags/team_diverse-affiliation.rst index 7de473bd0..b95eb15a0 100644 --- a/reference/tags/team_diverse-affiliation.rst +++ b/reference/tags/team_diverse-affiliation.rst @@ -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. diff --git a/reference/tags/team_single-vendor.rst b/reference/tags/team_single-vendor.rst index 4bae8233f..c487c479a 100644 --- a/reference/tags/team_single-vendor.rst +++ b/reference/tags/team_single-vendor.rst @@ -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.