Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Organization and Groups info to index file #322

Merged
merged 11 commits into from
Jul 1, 2021
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ property in `index.json`.
- `seriesComposition`: same as the [`seriesComposition`](README.md#seriesComposition)
property in `index.json`. The property must only be set for delta spec (since
full is the default).
- `organization`: same as the [`organization`](README.md#organization) property
in `index.json` to specify the name of the organization that owns the spec.
- `groups`: same as the [`groups`](README.md#groups) property in `index.json`
to specify the list of groups that develop or developed the spec.
- `nightly`: same as the [`nightly`](README.md#nightly) property in
`index.json`. The property must only be set when:
- The URL of the nightly spec returned by external sources would be wrong
Expand Down
46 changes: 37 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ cross-references, WebIDL, quality, etc.
- [`seriesComposition`](#seriescomposition)
- [`seriesPrevious`](#seriesprevious)
- [`seriesNext`](#seriesnext)
- [`organization`](#organization)
- [`groups`](#groups)
- [`release`](#release)
- [`release.url`](#releaseurl)
- [`release.filename`](#releasefilename)
Expand Down Expand Up @@ -83,34 +85,42 @@ Each specification in the list comes with the following properties:
```json
{
"url": "https://www.w3.org/TR/css-color-4/",
"seriesComposition": "full",
"shortname": "css-color-4",
"title": "CSS Color Module Level 4",
"shortTitle": "CSS Color 4",
"series": {
"shortname": "css-color",
"currentSpecification": "css-color-4",
"releaseUrl": "https://www.w3.org/TR/css-color/",
"nightlyUrl": "https://drafts.csswg.org/css-color/"
},
"seriesVersion": "4",
"seriesComposition": "full",
"seriesPrevious": "css-color-3",
"seriesNext": "css-color-5",
"organization": "W3C",
"groups": [
{
"name": "Cascading Style Sheets (CSS) Working Group",
"url": "https://www.w3.org/Style/CSS/"
}
],
"release": {
"url": "https://www.w3.org/TR/css-color-4/",
"filename": "Overview.html"
},
"nightly": {
"url": "https://drafts.csswg.org/css-color/",
"repository": "https://github.com/w3c/csswg-drafts",
"filename": "Overview.html",
"sourcePath": "css-color-4/Overview.bs"
"sourcePath": "css-color-4/Overview.bs",
"filename": "Overview.html"
},
"title": "CSS Color Module Level 4",
"source": "w3c",
"shortTitle": "CSS Color 4",
"tests": {
"repository": "https://github.com/web-platform-tests/wpt",
"testPaths": ["css/css-color"]
},
"source": "w3c"
"testPaths": [
"css/css-color"
]
}
}
```

Expand Down Expand Up @@ -256,6 +266,24 @@ The `shortname` of the next spec in the series.
The `seriesNext` property is only set where there is a next level or version.


### `organization`

The name of the standardization organization that owns the spec such as `W3C`,
`WHATWG`, `IETF`, `Ecma International`, `Khronos Group`.

The `organization` property is always set.


### `groups`

The list the groups that develop (or developed) the spec. Each item in the array
is an object with a `name` property that contains the human-readable name of the
group and a `url` property that targets the homepage of the group.

The `groups` property is always set. In most cases, a spec is developed by one
and only one group.


### `release`

An object that represents the latest published snapshot of the spec, when it
Expand Down
Loading