rfc14: allow attributes to have any value type #173
Merged
Conversation
This file contains 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
Problem: attributes are required to be strings in the JCR, but no comment is made in the text about allowed attribute types. Update the text to indicate that values may have any valid type. The JCR statement to the contrary will be fixed in a subsequent commit.
We are now using json-schema to validate jobspec. Replace the json-content-rules specification with the (sadly much more verbose and less readable) json-schema validator from flux-core. Fixes flux-framework#142
asciidoc (a2x) is abandonware and does not expand source include directives. Although github rendering of our adocs also no longer expands source include directives, asciidoctor does when generating HTML locally. Anticipating that we may host static html pages for our RFCs somewhere in the near future, set up Makefile command line to use asciidoctor to generate HTML. Add option to invoke 'coderay' for syntax highlighting, which handles both JSON and YAML.
Problem: The initial footnote referencing JCR (now json-schema) does not render properly. I haven't researched this in any great detail, but it seems that the "footnoteref" reusable footnote style used here is considered legacy, and a new scheme for reusable footnotes is used by asciidoctor where footnote:name[text] can be reused with footnote:name[]. However, that didn't seem to render properly on github. Rather than go down a rat hole on this, I felt the first footnote was not really needed, and simply eliminated it so there is only one json-schema footnote reference, thus it doesn't need to be "resusable".
|
Sorry for the forced pushes - I noticed the JCR (now json-schema) footnote was rendering improperly on github, tried to use a different footnote style, failed, and finally eliminated the additional reference to the footnote, which seems non-portable. Now at least it's rendering OK. |
Problem: The single reference in the RFC 14 is to JDSL which has no real bearing on the design of our jobspec, and no citations in the text. Drop the JDSL reference.
|
Thank you for taking care of this! |
|
NP! Thanks. |
This was referenced Mar 19, 2019
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.
As discussed in #172, this PR
Change the Makefile to generate html using asciidoctor and coderay, which makes a much prettier rendering, with inline source includes expanded and highlighted.
Sadly: github rendering of includes doesn't even produce a clickable link anymore. We really need to consider those other document publishing options, time permitting.