Installation

Setup

1. Install Visual Studio Code
2. Install Docker if working with the rfc-editor-drafts repositories, which rely on devcontainers. Optional otherwise.
3. Launch Visual Studio Code. In the left activity bar, click the Extensions icon.
4. Search for "draftforge" and install one of the following extension packs:
   • If you're part of the RFC Production Center staff, install the DraftForge for the RFC Production Center extension pack.
   • Otherwise, install the DraftForge for Internet-Draft Authors.
5. Read the Usage guide to start using it.

Warning

Do not install the "DraftForge" extension by itself, as you're going to be missing important dependencies. Use one of the two extension packs listed above instead.

They both bundle the core "DraftForge" extension and all the necessary 3^rd-party extensions dependencies.

Optional System Dependencies

GitHub repositories created under the rfc-editor-drafts organisation includes a devcontainer image, which contains all the necessary system dependencies. Therefore, you don't need to install anything listed below.

If you don't plan on working with these repositories or don't want to use the devcontainer image, you need to manually install these dependencies to be able to use all available features. Note that many of these packages are only used by the RPC and may not be relevant for authors.

Note

All binaries must be accessible from PATH.

• Python 3.x with the following packages:
  • pyang
  • rfc2html
  • rfcdiff
  • rfcstrip
  • svgcheck
  • xml2rfc with [pdf] flag
• Ruby with the following gems:
  • kramdown-rfc2629
• bap
• htmlwdiff
• prep