Re: [Emo-dir] quick-start guides

Mirja Kuehlewind <ietf@kuehlewind.net> Fri, 28 January 2022 10:38 UTC

Return-Path: <ietf@kuehlewind.net>
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 46D023A0962 for <emo-dir@ietfa.amsl.com>; Fri, 28 Jan 2022 02:38:29 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.897
X-Spam-Level:
X-Spam-Status: No, score=-1.897 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_NONE=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 3o1cHMzRqweT for <emo-dir@ietfa.amsl.com>; Fri, 28 Jan 2022 02:38:25 -0800 (PST)
Received: from wp513.webpack.hosteurope.de (wp513.webpack.hosteurope.de [IPv6:2a01:488:42:1000:50ed:8223::]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id E565A3A094E for <emo-dir@ietf.org>; Fri, 28 Jan 2022 02:38:24 -0800 (PST)
Received: from p200300dee73c6e005941ee6e3fc21f12.dip0.t-ipconnect.de ([2003:de:e73c:6e00:5941:ee6e:3fc2:1f12]); authenticated by wp513.webpack.hosteurope.de running ExIM with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) id 1nDOe3-0003MB-84; Fri, 28 Jan 2022 11:38:19 +0100
Content-Type: text/plain; charset="utf-8"
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.4\))
From: Mirja Kuehlewind <ietf@kuehlewind.net>
In-Reply-To: <51F3DD06-DA88-4DBD-ABBA-1CD0972326A4@amsl.com>
Date: Fri, 28 Jan 2022 11:38:16 +0100
Cc: emo-dir@ietf.org
Content-Transfer-Encoding: quoted-printable
Message-Id: <E541F3F3-21A6-416E-96A9-EB78E5050C0D@kuehlewind.net>
References: <51F3DD06-DA88-4DBD-ABBA-1CD0972326A4@amsl.com>
To: Alice Russo <arusso@amsl.com>
X-Mailer: Apple Mail (2.3608.120.23.2.4)
X-bounce-key: webpack.hosteurope.de;ietf@kuehlewind.net;1643366305;2ba07550;
X-HE-SMSGID: 1nDOe3-0003MB-84
Archived-At: <https://mailarchive.ietf.org/arch/msg/emo-dir/Iy9s7k9xI2Mq0h5LzjrwTNbveVU>
Subject: Re: [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: Fri, 28 Jan 2022 10:38:29 -0000

Thanks. I think that’s exactly what is needed. And I also revise my own statement from yesterday: I guess providing both xml and md makes sense as this is easy enough. Now we only need to to layout it nicely and put it in as many places as possible :-)


> On 27. Jan 2022, at 19:11, Alice Russo <arusso@amsl.com> wrote:
> 
> 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
> _______________________________________________
> Emo-dir mailing list
> Emo-dir@ietf.org
> https://www.ietf.org/mailman/listinfo/emo-dir
>