From nobody Mon Jan 31 00:45:41 2022
Return-Path: <lars@eggert.org>
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 0ED483A285A
 for <emo-dir@ietfa.amsl.com>; Mon, 31 Jan 2022 00:45:38 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.099
X-Spam-Level: 
X-Spam-Status: No, score=-2.099 tagged_above=-999 required=5
 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1,
 DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001,
 SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key)
 header.d=eggert.org
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 l7v5YYCA1bt4 for <emo-dir@ietfa.amsl.com>;
 Mon, 31 Jan 2022 00:45:32 -0800 (PST)
Received: from mail.eggert.org (mail.eggert.org [91.190.195.94])
 (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
 (No client certificate requested)
 by ietfa.amsl.com (Postfix) with ESMTPS id 60EC43A2857
 for <emo-dir@ietf.org>; Mon, 31 Jan 2022 00:45:32 -0800 (PST)
Received: from smtpclient.apple (unknown
 [IPv6:2a00:ac00:4000:400:49a9:3c31:e49e:a32a])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (No client certificate requested)
 by mail.eggert.org (Postfix) with ESMTPSA id 2F53B1D9BF5;
 Mon, 31 Jan 2022 10:45:21 +0200 (EET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=eggert.org; s=dkim;
 t=1643618721; bh=uexCZvfpbZW0Dl940B/NQ3bM/RO7f0ec3oI15b8/EHw=;
 h=Subject:From:In-Reply-To:Date:Cc:References:To;
 b=CznT84GftesSYd8FLxjJULDAHQQ6xsU/EORtusEJ5k185hiFbAdf5j//QzmZVeeJY
 kAU7apWSwSrsIZ2vy8WOHxg40FKu66lXNx3oTj95Ng9O0LjwHRvruoiq9tSY4EVKeH
 a6IYO4lXp8ziHCAgonc7N3DhJEExIwDjegTDAMgg=
Content-Type: multipart/signed;
 boundary="Apple-Mail=_1FD0A59E-3A1D-4099-849E-F7950704BA0A";
 protocol="application/pgp-signature"; micalg=pgp-sha512
Mime-Version: 1.0 (Mac OS X Mail 15.0 \(3693.60.0.1.1\))
From: Lars Eggert <lars@eggert.org>
In-Reply-To: <51F3DD06-DA88-4DBD-ABBA-1CD0972326A4@amsl.com>
Date: Mon, 31 Jan 2022 10:45:20 +0200
Cc: emo-dir@ietf.org
Message-Id: <2FBDEFE9-CE5B-4CD3-BE20-670056E836A4@eggert.org>
References: <51F3DD06-DA88-4DBD-ABBA-1CD0972326A4@amsl.com>
To: Alice Russo <arusso@amsl.com>
X-MailScanner-ID: 2F53B1D9BF5.A2964
X-MailScanner: Found to be clean
X-MailScanner-From: lars@eggert.org
Archived-At: <https://mailarchive.ietf.org/arch/msg/emo-dir/PZBSRoVvQMi-szCBjePwZ81RAZ0>
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: Mon, 31 Jan 2022 08:45:38 -0000


--Apple-Mail=_1FD0A59E-3A1D-4099-849E-F7950704BA0A
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain;
	charset=us-ascii

Hi,

do we want to (strongly) recommend kramdown-rfc2629 esp. for new =
documents?

It has a significantly lower bar than editing directly in XML.

Thanks,
Lars


> On 2022-1-27, at 20:11, Alice Russo <arusso@amsl.com> wrote:
>=20
> As discussed today. Outlines below as potential starting points.
>=20
> Alice
> --
>=20
> 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.
>=20
> 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.
>=20
> Note: If you prefer a GitHub workflow, see instructions on [6].
>=20
> [1] =
https://github.com/ietf-authors/rfcxml-templates-and-schemas/blob/main/dra=
ft-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-t=
odo-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


--Apple-Mail=_1FD0A59E-3A1D-4099-849E-F7950704BA0A
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment;
	filename=signature.asc
Content-Type: application/pgp-signature;
	name=signature.asc
Content-Description: Message signed with OpenPGP

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEmpq0ZpSoejRmyhheVLXDCb9wwVcFAmH3oaAACgkQVLXDCb9w
wVfHzQ/+IreSNxvnB//v8ZNRXdCBjK4KzDB4nA1iPEE7WmP9PFti8gQsrPIL54tV
PUcaC2MekqAgrjiU9keX3jNw4me7qG3rSj49jfz7YFhvrADQfgzyy00FpTF+B99f
9YidCW4tmVnqT1nyaQoADFh2Cn2h5pgsa8sl9BYMmkzfESWmv+KhPe2qWVCGooWx
NWyIshFC8r61rxnq24lwFFIC0Ue7NiYL8e2KmhxImGOO9GHRGZbmexZEqgrWIuKj
5TsszydX12b+hDSO0CCAvnUYwHKXTdH+wsAXzHomAjSCF5xf4AMc9ShgllbGcBEX
ONPAuuU6PFOlrS6Omwx09/4hoDO6owxkY+yomj8dy9yW7t1uK6pMNm+DSA8rxf9X
pscDIiu8nbxZGpUzEurDOcxU6QZwtE+71zqZnP/8QQe06BFRuPshrthcmwpTpQEi
G6Nihd6qBqwT87qjgKyxKE2TIYYtGbzPqUZAN66U9BNKCHJU+zNWELA+Ym9JvOJ4
/+dAaB4l/ERx+OvcFkMRLBJmrQvRTQySNvysalfxORN0a9II0yDdUpDYfF5L0bUz
DAczeSNjjQSEKSgi0SuU+Owg39TpMms2bvhVELCOkvksrkjcRV43xCwYBxCrgXpG
zAa24JLxVcUdC+97xQ/cG7K51Y9bGV35Uzd2Mc78cSFobe2TGCo=
=rzFA
-----END PGP SIGNATURE-----

--Apple-Mail=_1FD0A59E-3A1D-4099-849E-F7950704BA0A--

