From 833e4c6b8e6de8a5880351df8a0b5c0b131a2f6d Mon Sep 17 00:00:00 2001 From: Colin Maudry Date: Wed, 10 Mar 2021 13:37:05 +0100 Subject: [PATCH 1/9] Expanded guidance on additional tags #1214 --- schema/dereferenced-release-schema.json | 2 +- schema/release-schema.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/schema/dereferenced-release-schema.json b/schema/dereferenced-release-schema.json index 346144ba1..c1a4863ab 100644 --- a/schema/dereferenced-release-schema.json +++ b/schema/dereferenced-release-schema.json @@ -27,7 +27,7 @@ }, "tag": { "title": "Release Tag", - "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain.", + "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. It is encouraged to use tags from the releaseTags codelist whenever possible, but additional ones can be used based on specific use cases such as mapping with a particular notice, form or event.", "type": "array", "items": { "type": "string" diff --git a/schema/release-schema.json b/schema/release-schema.json index cb38167ef..b2a277c80 100644 --- a/schema/release-schema.json +++ b/schema/release-schema.json @@ -27,7 +27,7 @@ }, "tag": { "title": "Release Tag", - "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain.", + "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. It is encouraged to use tags from the releaseTags codelist whenever possible, but additional ones can be used based on specific use cases such as mapping with a particular notice, form or event.", "type": "array", "items": { "type": "string" From 995d99e8ac4aa9954530210700def6a96d87e6db Mon Sep 17 00:00:00 2001 From: Colin Maudry Date: Fri, 26 Mar 2021 17:27:18 +0100 Subject: [PATCH 2/9] Target the description both for users and publishers Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> --- schema/release-schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/release-schema.json b/schema/release-schema.json index b2a277c80..27b76fc65 100644 --- a/schema/release-schema.json +++ b/schema/release-schema.json @@ -27,7 +27,7 @@ }, "tag": { "title": "Release Tag", - "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. It is encouraged to use tags from the releaseTags codelist whenever possible, but additional ones can be used based on specific use cases such as mapping with a particular notice, form or event.", + "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. Codes outside the releaseTag codelist might indicate, for example, the notice or form to which the release corresponds, or the event that triggered the publication of the release.", "type": "array", "items": { "type": "string" From fded9aed722399c2930e197a3b90093635c62d46 Mon Sep 17 00:00:00 2001 From: Colin Maudry Date: Fri, 26 Mar 2021 17:28:34 +0100 Subject: [PATCH 3/9] Ran util scripts --- schema/dereferenced-release-schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/dereferenced-release-schema.json b/schema/dereferenced-release-schema.json index c1a4863ab..99f4e22a0 100644 --- a/schema/dereferenced-release-schema.json +++ b/schema/dereferenced-release-schema.json @@ -27,7 +27,7 @@ }, "tag": { "title": "Release Tag", - "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. It is encouraged to use tags from the releaseTags codelist whenever possible, but additional ones can be used based on specific use cases such as mapping with a particular notice, form or event.", + "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. Codes outside the releaseTag codelist might indicate, for example, the notice or form to which the release corresponds, or the event that triggered the publication of the release.", "type": "array", "items": { "type": "string" From 2935a8f87e049f8676ed64118f4b1ff52d26e07d Mon Sep 17 00:00:00 2001 From: Colin Maudry Date: Fri, 2 Apr 2021 15:09:23 +0200 Subject: [PATCH 4/9] Exapand the guidance for release tags #1214 --- docs/schema/codelists.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/schema/codelists.md b/docs/schema/codelists.md index 6322939f9..7384c69fd 100644 --- a/docs/schema/codelists.md +++ b/docs/schema/codelists.md @@ -23,7 +23,7 @@ Codes are case-sensitive, and are generally provided as English language camelCa ### Release Tag -A contracting process can result in a number of releases of information over time. These must be tagged to indicate the stage of the contracting process they relate to. +A contracting process can result in a number of releases of information over time. These must be tagged to indicate the stage of the contracting process they relate to. Whenever possible, a code from the codelist should be used, but additional codes can be used based on the publisher's use cases, such as the mapping of notice or event types. ```eval_rst .. codelisttable:: From 2d5330ddaba8be2e22985baba97c5f57fb7f1b3a Mon Sep 17 00:00:00 2001 From: Colin Maudry Date: Fri, 2 Apr 2021 15:17:06 +0200 Subject: [PATCH 5/9] Removed the recommendation to use existing codes --- docs/schema/codelists.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/schema/codelists.md b/docs/schema/codelists.md index 7384c69fd..cf6ac3992 100644 --- a/docs/schema/codelists.md +++ b/docs/schema/codelists.md @@ -23,7 +23,7 @@ Codes are case-sensitive, and are generally provided as English language camelCa ### Release Tag -A contracting process can result in a number of releases of information over time. These must be tagged to indicate the stage of the contracting process they relate to. Whenever possible, a code from the codelist should be used, but additional codes can be used based on the publisher's use cases, such as the mapping of notice or event types. +A contracting process can result in a number of releases of information over time. These must be tagged to indicate the stage of the contracting process they relate to. Additional codes can be used based on the publisher's use cases, such as the mapping of notice or event types. ```eval_rst .. codelisttable:: From 188f4d04b09c97d783105bf0da5fcb2814db0be1 Mon Sep 17 00:00:00 2001 From: Colin Maudry Date: Thu, 29 Apr 2021 09:54:50 +0200 Subject: [PATCH 6/9] Clarify some of the existing content. Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> --- schema/release-schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/release-schema.json b/schema/release-schema.json index 27b76fc65..7d2cda384 100644 --- a/schema/release-schema.json +++ b/schema/release-schema.json @@ -27,7 +27,7 @@ }, "tag": { "title": "Release Tag", - "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. Codes outside the releaseTag codelist might indicate, for example, the notice or form to which the release corresponds, or the event that triggered the publication of the release.", + "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. A tag labels the release: for example, as corresponding to a particular stage of the contracting process. Codes outside the releaseTag codelist might indicate, for example, the notice or form to which the release corresponds, or the event that triggered the publication of the release.", "type": "array", "items": { "type": "string" From cd12234739571826a4b30c7fc1ffa06f2e790386 Mon Sep 17 00:00:00 2001 From: Colin Maudry Date: Thu, 29 Apr 2021 09:56:11 +0200 Subject: [PATCH 7/9] Separate MUST and MAY, can => may Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> --- docs/schema/codelists.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/schema/codelists.md b/docs/schema/codelists.md index cf6ac3992..4e468f68b 100644 --- a/docs/schema/codelists.md +++ b/docs/schema/codelists.md @@ -23,7 +23,9 @@ Codes are case-sensitive, and are generally provided as English language camelCa ### Release Tag -A contracting process can result in a number of releases of information over time. These must be tagged to indicate the stage of the contracting process they relate to. Additional codes can be used based on the publisher's use cases, such as the mapping of notice or event types. +A contracting process can result in a number of releases of information over time. These must be tagged to indicate the stage of the contracting process they relate to. + +Additional codes may be used to label releases, based on user needs: for example, to indicate the notice or form to which a release corresponds. ```eval_rst .. codelisttable:: From fba436e61c667c346337f2eeb4b8c07f4b80d2c1 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Tue, 11 May 2021 19:58:38 -0400 Subject: [PATCH 8/9] requirements: Update sphinxcontrib-* --- requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/requirements.txt b/requirements.txt index 2c8eaff33..f25c4db92 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,6 +3,6 @@ # Add your own requirements below. linkify-it-py -sphinxcontrib-opencontracting==0.0.1 --e git+https://github.com/OpenDataServices/sphinxcontrib-jsonschema.git@75e4427b0f6f6a23dff9019aeb5d64833aab104a#egg=sphinxcontrib-jsonschema --e git+https://github.com/OpenDataServices/sphinxcontrib-opendataservices.git@fab0ff0167d32ec243d42f272e0e50766299c078#egg=sphinxcontrib-opendataservices +sphinxcontrib-opencontracting==0.0.3 +sphinxcontrib-opendataservices-jsonschema==0.2.0 +sphinxcontrib-opendataservices==0.1.0 From 2314294cf6f462dc86f1569dfa921ecca8cfdaf5 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Tue, 11 May 2021 20:08:34 -0400 Subject: [PATCH 9/9] build: Run: python utils/make_dereferenced_release_schema.py --- schema/dereferenced-release-schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schema/dereferenced-release-schema.json b/schema/dereferenced-release-schema.json index 164106f2e..7c3d93219 100644 --- a/schema/dereferenced-release-schema.json +++ b/schema/dereferenced-release-schema.json @@ -27,7 +27,7 @@ }, "tag": { "title": "Release Tag", - "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. Tags can be used to filter releases and to understand the kind of information that releases might contain. Codes outside the releaseTag codelist might indicate, for example, the notice or form to which the release corresponds, or the event that triggered the publication of the release.", + "description": "One or more values from the open [releaseTag](https://standard.open-contracting.org/{{version}}/{{lang}}/schema/codelists/#release-tag) codelist. A tag labels the release: for example, as corresponding to a particular stage of the contracting process. Codes outside the releaseTag codelist might indicate, for example, the notice or form to which the release corresponds, or the event that triggered the publication of the release.", "type": "array", "items": { "type": "string"