IETF 92 - Tutorials

Dallas, TX, USA
March 22 - 27, 2015

Writing RFCs and I-Ds in markdown and a bit of YAML

Presented by: Carsten Bormann

Day: Sunday, March 22, 2015
Time: 15:00-16:50
Room: Parisian

Description: Writing I-Ds has traditionally involved some finicky Word templating or typing up hard-to-use (and read!) XML. Recently, it has become more popular in a wide range of communities to write text in the plaintext-like "markdown" format. Tools have emerged in the IETF that allow writing I-Ds in markdown, automatically converting into the XML format accepted by the RFC editor (and performing a number of chores in the process that used to be manual work).

We'll look at what's available and then focus on the "kramdown" set of tools, which enhances markdown with a bit of structured YAML for the management of references. We'll also look at popular workflows that minimize manual work while optimizing collaboration with co-editors and contributors. Bring a laptop with a current version of the programming language Ruby (≥ 1.9) -- we'll do some exercises, and hands-on questions are welcome!

Link to Slides: Writing RFCs and I-Ds in markdown and a bit of YAML