From a7ae96b63025a36ccdfef524e36161d9233ff6f1 Mon Sep 17 00:00:00 2001 From: Iwan Aucamp Date: Sun, 4 Jul 2021 21:23:47 +0200 Subject: [PATCH 1/4] Clarify the meaning of the draft qualifier --- index.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/index.md b/index.md index b4a512cc..c85c7833 100644 --- a/index.md +++ b/index.md @@ -65,10 +65,19 @@ In the meantime, publication of Internet-Draft documents can be tracked through * [Relative JSON Pointers](https://datatracker.ietf.org/doc/draft-bhutton-relative-json-pointer/) Internet-Drafts expire after six months, so our goal is to publish often enough to always have a set of unexpired drafts available. There may be brief gaps as we wrap up each draft and finalize the text. + -The intention, particularly for vocabularies such as validation which have been widely implemented, is to remain as compatible as possible from draft to draft. However, these are still drafts, and given a clear enough need validated with the user community, major changes can occur. +### Use of the _draft_ qualifier - +Releases of the JSON schema specification and meta schemas are qualified as _draft_ primarily for historical reasons stemming from the relationship of this specification to IETF. + +The JSON schema project recognizes, condones and advocates for the use of the JSON schema standard in production. + +Each release of the JSON schema is treated as a production release by the JSON schema project. All changes in each new release are made judiciously, with great care and thorough review with careful consideration of how the changes will impact existing users and implementations of the JSON schema specification. + +Similarly to most specifications, the JSON schema specification will continue to evolve, and not all releases will be backwards compatible. The intention, particularly for vocabularies such as validation which have been widely implemented, is to remain as compatible as possible from release to release. However, major changes can still occur given a clear enough need validated with the user community. + +At some point, the draft qualifier will be dropped, and this may indicate that the frequency of releases and amount of changes in each release will decrease, but it won't indicate that no new releases will be made, or that all future releases will be backwards compatible. ## Quickstart From 14e53de8139ab4bd13caba6b5d5e93796f429458 Mon Sep 17 00:00:00 2001 From: Iwan Aucamp Date: Mon, 5 Jul 2021 22:07:53 +0200 Subject: [PATCH 2/4] Update index.md Fix grammar Co-authored-by: Jason Desrosiers --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index c85c7833..c449d2b9 100644 --- a/index.md +++ b/index.md @@ -73,7 +73,7 @@ Releases of the JSON schema specification and meta schemas are qualified as _dra The JSON schema project recognizes, condones and advocates for the use of the JSON schema standard in production. -Each release of the JSON schema is treated as a production release by the JSON schema project. All changes in each new release are made judiciously, with great care and thorough review with careful consideration of how the changes will impact existing users and implementations of the JSON schema specification. +Each release of the JSON schema specification is treated as a production release by the JSON schema project. All changes in each new release are made judiciously, with great care and thorough review with careful consideration of how the changes will impact existing users and implementations of the JSON schema specification. Similarly to most specifications, the JSON schema specification will continue to evolve, and not all releases will be backwards compatible. The intention, particularly for vocabularies such as validation which have been widely implemented, is to remain as compatible as possible from release to release. However, major changes can still occur given a clear enough need validated with the user community. From 24c9a1d930dc877849789c775213e478a6e6668b Mon Sep 17 00:00:00 2001 From: Iwan Aucamp Date: Tue, 6 Jul 2021 01:12:02 +0200 Subject: [PATCH 3/4] Add rationale for continued use of draft designation Also change "qualifier" to "designation", and fix grammar in third paragraph. --- index.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/index.md b/index.md index c449d2b9..b0a7dc0d 100644 --- a/index.md +++ b/index.md @@ -67,17 +67,18 @@ In the meantime, publication of Internet-Draft documents can be tracked through Internet-Drafts expire after six months, so our goal is to publish often enough to always have a set of unexpired drafts available. There may be brief gaps as we wrap up each draft and finalize the text. -### Use of the _draft_ qualifier +### Use of the _draft_ designation -Releases of the JSON schema specification and meta schemas are qualified as _draft_ primarily for historical reasons stemming from the relationship of this specification to IETF. +Releases of the JSON schema specification and meta schemas use the _draft_ designation primarily for historical reasons stemming from the relationship of this specification to IETF ([explained here](https://json-schema.org/specification-links.html#understanding-draft-names-and-numbers)). +The use of this designation is under review but will continue until this review process completes to avoid changing the designation style multiple times. The JSON schema project recognizes, condones and advocates for the use of the JSON schema standard in production. -Each release of the JSON schema specification is treated as a production release by the JSON schema project. All changes in each new release are made judiciously, with great care and thorough review with careful consideration of how the changes will impact existing users and implementations of the JSON schema specification. +Each release of the JSON schema specification is treated as a production release by the JSON schema project. All changes in each new release are made judiciously, with great care, thorough review and careful consideration of how the changes will impact existing users and implementations of the JSON schema specification. Similarly to most specifications, the JSON schema specification will continue to evolve, and not all releases will be backwards compatible. The intention, particularly for vocabularies such as validation which have been widely implemented, is to remain as compatible as possible from release to release. However, major changes can still occur given a clear enough need validated with the user community. -At some point, the draft qualifier will be dropped, and this may indicate that the frequency of releases and amount of changes in each release will decrease, but it won't indicate that no new releases will be made, or that all future releases will be backwards compatible. +When the _draft_ designation is dropped this may indicate that the frequency of releases and amount of changes in each release will decrease, but it won't indicate that no new releases will be made, or that all future releases will be backwards compatible. ## Quickstart From 11d2ab15dd250418be0f0a65054c8252104a689d Mon Sep 17 00:00:00 2001 From: Iwan Aucamp Date: Tue, 6 Jul 2021 18:44:10 +0200 Subject: [PATCH 4/4] Update index.md add oxford comma Co-authored-by: Ben Hutton --- index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.md b/index.md index b0a7dc0d..27d80190 100644 --- a/index.md +++ b/index.md @@ -72,7 +72,7 @@ Internet-Drafts expire after six months, so our goal is to publish often enough Releases of the JSON schema specification and meta schemas use the _draft_ designation primarily for historical reasons stemming from the relationship of this specification to IETF ([explained here](https://json-schema.org/specification-links.html#understanding-draft-names-and-numbers)). The use of this designation is under review but will continue until this review process completes to avoid changing the designation style multiple times. -The JSON schema project recognizes, condones and advocates for the use of the JSON schema standard in production. +The JSON schema project recognizes, condones, and advocates for the use of the JSON schema standard in production. Each release of the JSON schema specification is treated as a production release by the JSON schema project. All changes in each new release are made judiciously, with great care, thorough review and careful consideration of how the changes will impact existing users and implementations of the JSON schema specification.