[Emo-dir] quick-start guides

Alice Russo <arusso@amsl.com> Thu, 27 January 2022 18:11 UTC

Return-Path: <arusso@amsl.com>
X-Original-To: emo-dir@ietfa.amsl.com
Delivered-To: emo-dir@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id BD2723A089B for <emo-dir@ietfa.amsl.com>; Thu, 27 Jan 2022 10:11:38 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id L7_5916mKPwk for <emo-dir@ietfa.amsl.com>; Thu, 27 Jan 2022 10:11:36 -0800 (PST)
Received: from c8a.amsl.com (c8a.amsl.com [4.31.198.40]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 1DA533A0899 for <emo-dir@ietf.org>; Thu, 27 Jan 2022 10:11:36 -0800 (PST)
Received: from localhost (localhost [127.0.0.1]) by c8a.amsl.com (Postfix) with ESMTP id 0C9A1425A346 for <emo-dir@ietf.org>; Thu, 27 Jan 2022 10:11:36 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
Received: from c8a.amsl.com ([127.0.0.1]) by localhost (c8a.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id Y5LIRFLtuX_N for <emo-dir@ietf.org>; Thu, 27 Jan 2022 10:11:36 -0800 (PST)
Received: from [192.168.4.33] (c-24-17-19-210.hsd1.wa.comcast.net [24.17.19.210]) by c8a.amsl.com (Postfix) with ESMTPSA id E880C425A344 for <emo-dir@ietf.org>; Thu, 27 Jan 2022 10:11:35 -0800 (PST)
From: Alice Russo <arusso@amsl.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\))
Message-Id: <51F3DD06-DA88-4DBD-ABBA-1CD0972326A4@amsl.com>
Date: Thu, 27 Jan 2022 10:11:34 -0800
To: emo-dir@ietf.org
X-Mailer: Apple Mail (2.3273)
Archived-At: <https://mailarchive.ietf.org/arch/msg/emo-dir/6dcl1_eo099EXRKRPTetaR10z6I>
Subject: [Emo-dir] quick-start guides
X-BeenThere: emo-dir@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: "Education, Mentoring & Outreach Directorate" <emo-dir.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/emo-dir>, <mailto:emo-dir-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/emo-dir/>
List-Post: <mailto:emo-dir@ietf.org>
List-Help: <mailto:emo-dir-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/emo-dir>, <mailto:emo-dir-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 27 Jan 2022 18:11:39 -0000

As discussed today. Outlines below as potential starting points.

Alice
--

A) Quick-start guide for editing in XML
   - Start with a file (an existing I-D or template [1]).
   - Edit it w/ the software of your choice.
     -> Tip: Rely on the citation library by using xi:include [2].
   - Convert it using https://author-tools.ietf.org.
   - Upload it to the I-D submission tool [3].
   - Share it and update it.

B) Quick-start guide for editing in markdown (specifically kramdown-rfc2629)
   - Start with a file (an existing I-D or template [4]).
   - Edit it w/ the software of your choice.
     -> Tip: Rely on the citation library by using a YAML header [5].
   - Convert it using https://author-tools.ietf.org.
   - Upload it to the I-D submission tool [3].
   - Share it and update it.

Note: If you prefer a GitHub workflow, see instructions on [6].

[1] https://github.com/ietf-authors/rfcxml-templates-and-schemas/blob/main/draft-rfcxml-general-template-standard-00.xml
[2] https://authors.ietf.org/references-in-rfcxml
[3] https://datatracker.ietf.org/submit/
[4] https://github.com/martinthomson/internet-draft-template/blob/main/draft-todo-yourname-protocol.md
[5] https://github.com/cabo/kramdown-rfc2629#references
[6] https://github.com/martinthomson/i-d-template/blob/main/doc/TEMPLATE.md