docs: add an upgrade guide for 1.0.0, and pin oold 2.1.0 - #191
Merged
Merged
Conversation
Nineteen rules landed across rc.4 and rc.5 with no page a reader could learn that from. The root @context requirement alone breaks every schema written against rc.3 that does not carry one.
simontaurus
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two things, both needed before the tag.
Upgrade guide
Nineteen rules landed across rc.4 and rc.5, several of them breaking, and there was no page on which a reader could learn that happened. The
sincefield in the rule catalogue was the only record, and it is per-rule rather than per-release.Covers what can make a working document or tool stop working:
@contextrequirement, with the reason it is a MUST rather than a recommendation, and the note that presence is not content so{}satisfies itx-oold-reverse-default-propertiesremoved from the vocabularyOOLD-INS-770a, a bare IRI reference needing@type: "@id"OOLD-EXT-3ea9,x-oold-rangeandx-oold-refas URI references rather than compact IRIsPublished at
/upgrading/, in the nav beside Contributing.Validator pin to 2.1.0
oold2.1.0 adds the named checks forOOLD-SCH-96a3andOOLD-EXT-c77a(OO-LD/oold-python#171). With the pin bumped,coverage.rulesreports 28 of 47 machine-checkable rules covered, up from 26 of 48 at rc.4, and the root@contextrequirement is enforced by a check that names it rather than only by the meta-schema.make checkpasses end to end.