opoudjis
commented
6 years ago This site will provide instructions on how to generate XML RFC documents via Asciidoctor and our toolkit. The XML RFC documents get submitted to https://www.ietf.org, but the submission process should already be familiar to users; the point is that IETF now requires XML rather than TXT submissions, and our authoring tool is one of several tools that will generate XML from a markup language. (And that the markup language and toolset we use are pedantic enough that the XML is usefully validated by the tool.)
This site will contain content from the following sources:
https://asciidoctor.org/docs/user-manual/ (the Asciidoctor user manual: we should not be replicating its content, but we should be referring off to it. We can ask people to get familiar with Asciidoctor markup first, but we also provide document templates for people to populate) https://github.com/riboseinc/asciidoctor-rfc/blob/master/README.adoc (which is the complete guide for end users, but which presupposes you're already familiar with Asciidoctor) https://datatracker.ietf.org/doc/draft-ribose-asciirfc/ (which is the streamlined walk-through of the XML output format being generated, and how we're describing the tool to the IETF; you can draw on it and its examples secondarily) https://github.com/riboseinc/rfc-asciirfc-minimal (small sample document)
We're going to create a project site for AsciiRFC, at the aptly-named https://www.asciirfc.com.
Open source project:
IETF draft:
@opoudjis will provide guidance on information architecture and content.