Re: [Emo-dir] quick-start guides

[Lars Eggert <[e-mail]>]

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 <[e-mail]> 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
> [e-mail]
> https://www.ietf.org/mailman/listinfo/emo-dir