-
-
Notifications
You must be signed in to change notification settings - Fork 65
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Write spec in IETF RFC style #461
Comments
I've done a preliminary conversion in main...jyasskin:kdl:main, whose result you can see at https://jyasskin.github.io/kdl/draft-marchan-kdl2.html. I haven't proofread it in detail, but there are definitely some stylistic things still to clean up ( Before I do that stylistic pass and send a PR:
Any other comments are also welcome. |
@jyasskin I really like this! Thanks for taking the time. I was thinking recently that maybe we should have both the RFC-style and the “classic” spec, but I think your example makes clear that RFC style wouldn’t really take away from the readability, and might even add some clarity in key places. One thing I’m wondering: are we required to use ABNF for official RFCs? While most of the grammar is probably translatable to it (though with maybe less readability), we do things like requiring non-greedy parsing that I don’t think ABNF accommodates. I clearly haven’t read enough RFCs :) All in all I like this and it makes things feel much more cleaned-up and… “professional”? Also, using my last name is fine. I’d prefer to use my full name for this if possible (Katerina Zoé Marchán Salvá), but my first last name without the accent (marchan) is fine for the file name. |
ABNF is not required for describing syntax in RFCs. It's common, but for example, TLS has its own language, and HTTP Structured Headers include ABNF but say that the algorithmic parsing is normative. If this were going through a WG, you could get away with anything the community decided was worth it, and an Independent submission is supposed to be even more accepting. (The IESG might decide this is worth chartering a small WG for, since it might be a "foundational formats upon which standards are expected to be built", but you can deal with that when you get to it.) I've fixed your name and guessed at the initials you want in the top of the document (https://github.com/cabo/kramdown-rfc/wiki/Syntax2#authors-contributors). I've sent #466, so you can let me know what should change there. |
Regardless of when we decide to submit KDL for consideration as an Internet standard, it might make sense to rewrite the format of the KDL spec such that it meets the requirements for an IETF RFC.
This MUST NOT change any of the semantics of the spec, as it’s intended to just be a formatting change.
This is related to #460, since it’s one potential avenue for achieving it, but also I think it would be nice to have such a well-known, -understood, and formal structure to the KDL spec
This is very much open to community members to participate in and I expect it to be a somewhat laborious process with multiple people involved. If you’re someone in our community and you’re familiar with the RFC format and process, and you’d like to get involved, please do chime in! Any level of involvement and help is welcome. I’ve definitely never done this before.
The text was updated successfully, but these errors were encountered: