rfc40: pull fluxion scheduling key def out of rfc20 and reformat rfc20 #401
Conversation
| - [37/File Archive Format](spec_37.rst) | ||
| - [38/Flux Security Key Value Encoding](spec_38.rst) | ||
| - [39/Flux Security Signature](spec_39.rst) | ||
| - [40/Fluxion Resource Set Extension](spec_40.rst) |
There was a problem hiding this comment.
Commit message nit: capitalization of Fluxion is inconsistent.
Problem: rfc20 defines Rv1 with a key for scheduler extensions, but then proceeds to prescribe the Fluxion JGF format. Move the Fluxion resource set extension to its own RFC.
Problem: RFC 20's use of headings is slightly weird compared to the sphinx style guide's recommendations. Use the recommended H1, H2, H3, and H4 heading symbols. See also: https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html
Problem: when describing the R JSON object, hierarchical key relationships are not visually evident. Set the default domain to js (javascript) and use nested data directives to define JSON elements, and the :data: role for mentions of them to improve formatting and add cross-reference links. See also: https://www.sphinx-doc.org/en/master/usage/domains/javascript.html
|
Thanks - fixed that and also a heading level problem that was messing up the table of contents tab. Note the |
Yeah, I was wondering the same thing on a read-through. It seems like if it is necessary for Fluxion it should go in the opaque There is still code in Fluxion to emit the attributes section in the RV1 "writer" here: But I don't know when it is used. |
|
Those attributes seem to be required by the |
|
I'll go ahead and set MWP on this content-free update. We can ponder whether we want to drop that section in another PR and open a Fluxion issue to get it inline with how Flux's design for queues has evolved. |
2 participants
Problem: the detailed description of Fluxion's scheduling key format is inappropriate in RFC 20 which describes the general Rv1 format.
Pull it out to a new RFC 40.
Also, improve the markup in RFC 20 to make it more readable.