Skip to content

Commit d73d3fa

Browse files
committed
Remove references to spec-prod
1 parent ebe1c06 commit d73d3fa

1 file changed

Lines changed: 16 additions & 22 deletions

File tree

README.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,14 @@
99
Specifications are written in markdown, or technically
1010
[bikeshed](https://github.com/tabatkins/bikeshed) -- a markdown document, with
1111
special extensions understood by the bikeshed tool. The bikeshed tool is run
12-
on-commit via the [spec-prod github action](https://github.com/w3c/spec-prod),
13-
generating the familiar "spec looking" ReSpec format. ReSpec is just html with
14-
a javascript ReSpec library.
15-
16-
Specification files end with the .bs file extension. The github action runs on
17-
commit to automatically convert to respec/html, via bikeshed.
12+
during the Sphinx build step (see conf.py).
1813

1914
[Learn more about bikeshed](https://w3c-ccg.github.io/bikeshed_instructions.html)
2015

2116
## Reviewing
2217

23-
Commits on GitHub can be viewed using web services from the W3C:
18+
Commits on GitHub can be viewed at PR-numbered URLs provided by readthedocs.
19+
Additionally, bikeshed pages can be viewed using web services from the W3C:
2420

2521
* Rendered page: http://api.csswg.org/bikeshed/?url=https://raw.githubusercontent.com/ome/ngff/master/0.2/index.bs
2622
* Diff: https://services.w3.org/htmldiff?doc1=https%3A%2F%2Fngff.openmicroscopy.org%2F0.2%2F&doc2=http%3A%2F%2Fapi.csswg.org%2Fbikeshed%2F%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fome%2Fngff%2Fmaster%2Flatest%2Findex.bs
@@ -46,24 +42,22 @@ specification document using the
4642
[include-code](https://tabatkins.github.io/bikeshed/#including-code) directive.
4743

4844
The official OME-NGFF JSON schemas are published under
49-
https://ngff.openmicroscopy.org/<version>/schemas/<schema_name>.schema using the
50-
[Spec prod](https://github.com/ome/spec-prod) GitHub action. When a new JSON schema is introduced,
51-
this action needs to be reviewed to update the deployment script and allow the publication
52-
of the schema.
45+
https://ngff.openmicroscopy.org/<version>/schemas/<schema_name>.schema.
5346

5447
# Release process
5548

56-
* copy `latest/index.bs` to `$VERSION/index.bs`
57-
* copy `latest/copyright.include` to `$VERSION/copyright.include`
58-
* update the head matter in the `$VERSION`ed file
59-
* Use: `Status: w3c/CG-FINAL`
60-
* Update `URL: `
61-
* Use the following `Status Text:`: "This is the $VERSION release of this specification.
62-
Migration scripts will be provided between numbered versions. Data written with the latest version
63-
(an "editor's draft") will not necessarily be supported."
64-
* update the footer matter in the `$VERSION`ed file
65-
* Version in the citation block including release date
66-
* Update https://github.com/ome/spec-prod for the new version
49+
* For patch releases, bump the submodule for the given version.
50+
* For minor and major versions, add a new submodule location for the version branch.
51+
* Check and update:
52+
- copyright.include
53+
- the head matter in the `$VERSION`ed file
54+
* Use: `Status: w3c/CG-FINAL`
55+
* Update `URL: `
56+
* Use the following `Status Text:`: "This is the $VERSION release of this specification.
57+
Migration scripts will be provided between numbered versions. Data written with the latest version
58+
(an "editor's draft") will not necessarily be supported."
59+
- update the footer matter in the `$VERSION`ed file
60+
- Version in the citation block including release date
6761

6862
# Citing
6963

0 commit comments

Comments
 (0)