Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

Commit 1224440

Browse files
committed
Update work-in-progress index for "draft-08"
and also link to it from the front page. No documents in this commit, they will be in the next one.
1 parent bf97862 commit 1224440

File tree

2 files changed

+118
-14
lines changed

2 files changed

+118
-14
lines changed

index.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ permalink: /
77
***The current version is [draft-07](specification.html)!***
88
{: style="color:gray; font-size: 150%; text-align: center;"}
99

10+
***The next draft work-in-progres is [in final review](work-in-progress/)!***
11+
{: style="color:red; font-size: 150%; text-align: center;"}
12+
1013
**JSON Schema** is a vocabulary that allows you to **annotate** and **validate** JSON documents.
1114

1215

@@ -37,21 +40,13 @@ permalink: /
3740

3841
## Project Status
3942

40-
### Update as of 31 March 2019
41-
42-
**You may be wondering _what in the world is going on with this draft?_ The short version is: we are entering the home stretch. There are some ideas for simplifying `$id` that we are considering, and then there will be a final review period for feedback on overall flow and clarity.**
43-
44-
As for the long version: The original intent was to publish by the time the previous draft by or at least soon after the current Core and Validation drafts expired on 20 September, 2018. The project is a volunteer project, and one editor was driving most of the large changes in this draft.
45-
46-
Unfortunately, that editor had a lot of Real Life Stuff(tm) to deal with this past year, including changing jobs (which put things on hold from about May through August or so) and then a run of minor health issues (which put things on hold from November through February). Other contributors made progress during those times,
47-
48-
As of March, everyone is back to working towards the publication of the draft as schedules permit.
43+
### Update as of 27 May 2019
4944

50-
We expect to publish a new round of drafts (Core, Validation, Hyper-Schema, Relative JSON Pointer) in the next month or two, and are actively working on the last few PRs. While the drafts are currently expired, they are still under active development. This project is staffed by volunteers, and life occasionally disregards IETF expiration schedules.
45+
**The forthcoming draft is in [final review](work-in-progress/).**
5146

5247
This draft has also taken more time than expected because it tackles deep, long-term issues that have long been a challenge for JSON Schema. This includes building in a formal extensibility mechanism so that we can more easily draw a line to finalize the contents of the Core and Validation specifications.
5348

54-
Progress on the next set of Internet-Drafts can be tracked on GitHub. The [draft-08](https://github.com/json-schema-org/json-schema-spec/milestone/6) milestone will track the evolving scope of the draft (although see [issue #612](https://github.com/json-schema-org/json-schema-spec/issues/612) for a discussion of whether "draft-08" is the right name for this milestone).
49+
Additionally, numerous life issues reduced the availability of key contributors during the process.
5550

5651
### The Path to Standardization
5752

work-in-progress/index.md

Lines changed: 112 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,116 @@ permalink: /work-in-progress
77
* TOC
88
{:toc}
99

10-
**draft-07** (a.k.a. **draft-handrews-\*-00**) has been released!
11-
Please see the [specification](../documentation.md) page for details.
10+
## The Next Draft (by whatever name) Is Ready for Final Pre-Publication Review!
11+
12+
The forthcoming draft is now feature-frozen and entering the final four-week feedback
13+
period before publication. This final review will last from May 27th to June 24th, 2019.
14+
15+
The timeline may be compressed if, after at least two weeks, there is a clear consensus that
16+
the drafts are solid and it would be best to publish sooner rather than later.
17+
18+
The following sorts of feedback are particularly desired:
19+
20+
* Clarity, readability, and accessibility to new readers
21+
* Contradictions, inconsistencies and other bugs
22+
* Anything so egregious that implementation would be infeasible or impossible
23+
24+
New features or major changes to existing features will be deferred to a future draft,
25+
and work on the next draft will begin immediately after this one is published.
26+
27+
## What Is This Draft Called, Anyway?
28+
29+
We have typically referred to this as `draft-08`, following our own convention of just
30+
incrementing the draft number for meta-schemas regardless of the IETF identifier.
31+
32+
However, this is frowned upon by the IETF and has in fact been a source of confusion.
33+
It worked well up to and including `draft-04`, as even after the split into multiple
34+
documents, `draft-zyp-json-schema-04` (the core spec) at least ended in `-04`!
35+
Unfortnately, after that point, the numbers stopped matching in any way.
36+
37+
Assuming this new draft gets published more or less as presented in this WIP,
38+
and by the end of June, it will be:
39+
40+
* IETF identifiers: `draft-handrews-*-02`
41+
* Meta-schema identifiers: `draft/2019-06`
42+
43+
Meta-schemas will now be identified with dates, which can be correlated with the publication
44+
and expiration dates of the IETF documents. This will make it more clear when a bugfix
45+
meta-schema is produced, and also make it more obvious that the IETF and meta-schema identifiers
46+
are not expected to match exactly.
47+
48+
## Pre-Built Review Documents
49+
50+
To encourage as many reviewers as possible, pre-built documents are available. These may
51+
slightly lag those in the GitHub repository, although all efforts will be made to keep them
52+
in sync during the review period. After the review period, these will be removed. In particular,
53+
using "WORK IN PROGRESS" meta-schemas **is not allowed** and **will break** as soon as the files
54+
are moved to their permanent homes.
55+
56+
### Specifications:
57+
58+
As always, these are the actual normative documents:
59+
60+
_**NOTE:** Links to meta-schemas and among the drafts will not work correctly in these review copies._
61+
62+
* [WIP: JSON Schema (core)](/work-in-progress/WIP-jsonschema-core.html)
63+
* [WIP: JSON Schema Validation](/work-in-progress/WIP-jsonschema-validation.html)
64+
* [WIP: JSON Schema Hyper-Schema](/work-in-progress/WIP-jsonschema-hyperschema.html)
65+
* [WIP: Relative JSON Pointer](/work-in-progress/WIP-relative-json-pointer.html)
66+
67+
### General use meta-schemas:
68+
69+
These are the traditional non-normative meta-schemas, which serve the same purpose as
70+
in previous drafts, although their internal structure is different.
71+
72+
_**NOTE:** when published, the `.json` will be removed from the final URI_
73+
74+
* [WIP: schema.json](/work-in-progress/WIP-schema.json) (core and validation)
75+
* [WIP: links.json](/work-in-progress/WIP-links.json) (individual link description object)
76+
* [WIP: hyper-schema.json](/work-in-progress/WIP-hyper-schema.json) (hyper-schema, references schema and links)
77+
78+
### Single-vocabulary meta-schemas:
79+
80+
The new draft introduces the concept of modular vocabularies. Most schema authors will not directly
81+
reference these meta-schemas. Instead, they are combined in useful ways by the general use meta-schemas.
82+
However, those wishing to build custom meta-schemas may find it useful to choose different subsets of
83+
the standard keywords depending on the custom meta-schema's intended purpose.
84+
85+
_**NOTE:** when published, the `.json` will be removed from the final URI_
86+
87+
* [WIP: meta/core.json](/work-in-progress/meta/WIP-core.json) (core keywords, from the core spec)
88+
* [WIP: meta/applicator.json](/work-in-progress/meta/WIP-applicator.json) (applicator keywords, from the core spec)
89+
* [WIP: meta/validation.json](/work-in-progress/meta/WIP-validation.json) (validation assertions, from the validation spec)
90+
* [WIP: meta/meta-data.json](/work-in-progress/meta/WIP-meta-data.json) (meta-data annotations, from the validation spec)
91+
* [WIP: meta/format.json](/work-in-progress/meta/WIP-format.json) (the format keyword, from the validation spec)
92+
* [WIP: meta/content.json](/work-in-progress/meta/WIP-content.json) (content keywords, from the validation spec)
93+
* [WIP: meta/hyper-schema.json](/work-in-progress/meta/WIP-hyper-schema.json) (hyper-schema keywords, from the hyper-shema spec)
94+
95+
### Output schema:
96+
97+
The new draft also introduces recommended output formats for reporting errors and annotations.
98+
99+
_**NOTE:** when published, the `.json` will be removed from the final URI_
100+
101+
* [WIP: schema.json](/work-in-progress/output/WIP-schema.json) (schema for recommended output formats)
102+
* [WIP: verbose-example.json](/work-in-progress/output/WIP-verbose-example.json) (example of the most verbose output format)
103+
* [WIP: hyper-schema.json](/work-in-progress/output/WIP-hyper-schema.json) (format used by the proposed hyper-schema test suite, and used in examples in the specification)
104+
105+
## Providing Feedback and Tracking Progress in GitHub
106+
107+
We are **particularly interested** in feedback on whether the wording and concepts is an
108+
improvement in terms of how easy it is to understand and learn the specifications.
109+
110+
Note that _all drafts have Changelog appendicies_, for a concise list of notable changes.
111+
112+
* The active sources are on the
113+
["master" branch of json-schema-org/json-schema-spec](https://github.com/json-schema-org/json-schema-spec)
114+
* The [draft-08 milestone](https://github.com/json-schema-org/json-schema-spec/milestone/6)
115+
tracks all issues and PRs for this draft
116+
_(yes, it's still called draft-08 here because GitHub doesn't handle milestone renames well)_
117+
* Check the [open PRs](https://github.com/json-schema-org/json-schema-spec/pulls)
118+
to see what is already being changed from other feedback
119+
* [file an issue](https://github.com/json-schema-org/json-schema-spec/issues/new?milestone=draft-08)
120+
or [join us on Slack](https://join.slack.com/t/json-schema/shared_invite/enQtMjk1NDcyNDI2NTAwLTcyYmYwMjdmMmUxNzZjYzIxNGU2YjdkNzdlOGZiNjIwNDI2M2Y3NmRkYjA4YmMwODMwYjgyOTFlNWZjZjAyNjg) to submit feedback
121+
_(technically there is also a [mailing list](https://groups.google.com/forum/#!forum/json-schema) but it gets very little traffic and is not closely monitored)_
12122

13-
This page will remain empty until draft-08 enters the final pre-publication review period.

0 commit comments

Comments
 (0)