Repository navigation
RFC 089: link the rendered Identifiers API reference - #177
Merged
Merged
Conversation
The Markdown rendering and render_docs.py are gone from catalogue-api; the spec now renders on developers.wellcomecollection.org. Part of wellcomecollection/platform#6644
7 tasks
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
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.
Preview
RFC 089 on this branch
What does this change?
Fixes wellcomecollection/platform#6644.
RFC 089's spec section linked a Markdown rendering that catalogue-api no longer has. It now links the reference on developers.wellcomecollection.org, says how that copy is produced, and lists what the spec fragment carries today.
How to test
.scripts/validate_rfc.py rfcs/089-identifiers-api/README.mdpasses, and the link opens the rendered reference.How can we measure success?
The RFC has no dead spec links.
Have we considered potential risks?
Merge after the developers site has deployed
/api/identifiers, or the link 404s.