Re: [Tools-discuss] [rfc-i] Recommendation 9 from Results and analysis of the survey of I-D authors on formats and tools

"Andrew G. Malis" <agmalis@gmail.com> Sat, 06 February 2021 22:52 UTC

Return-Path: <agmalis@gmail.com>
X-Original-To: tools-discuss@ietfa.amsl.com
Delivered-To: tools-discuss@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D68AF3A2CDE for <tools-discuss@ietfa.amsl.com>; Sat, 6 Feb 2021 14:52:07 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -2.097
X-Spam-Level:
X-Spam-Status: No, score=-2.097 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, FREEMAIL_FROM=0.001, HTML_MESSAGE=0.001, 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 (2048-bit key) header.d=gmail.com
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 WJFipKSZDr6S for <tools-discuss@ietfa.amsl.com>; Sat, 6 Feb 2021 14:52:06 -0800 (PST)
Received: from mail-qk1-x72e.google.com (mail-qk1-x72e.google.com [IPv6:2607:f8b0:4864:20::72e]) (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 282643A2CDD for <tools-discuss@ietf.org>; Sat, 6 Feb 2021 14:52:05 -0800 (PST)
Received: by mail-qk1-x72e.google.com with SMTP id l27so10768999qki.9 for <tools-discuss@ietf.org>; Sat, 06 Feb 2021 14:52:05 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=+Ler5mW88vbT/UvRPrCHQKC22dw10oBcIhcSoEbif6M=; b=ekAJX8D0EIKxSO9DI77c7LVWtz6iNnTkpToT3eirCZgMfzMEbDcVGh2OTJKuTgQbD8 fHjM4V2XU+UPdugh4HeGCuzDiDKpGadL5nHBZ6HafOKmbvoYgIrOCiycKqDVqBBQsyuh EcPdtC54eJ5Z3Py6YJA2usRsH4gyS88cNIwhoxqJG/xKUwupqmqbmkLgR6KdKD5dP0+T fpchOotHRIa0hXydlSlJ7g6JPHGaZBgjvOpZklemTH8FmJwa54Om9UwpEYQEwZJF3Yx1 A/wi1ehRg1sNtINAu3bTyEHRV7dJ1QOzi1qcVaPJ2xCax6I7yl55Xq7JKF9bzjj62ozI PIbQ==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=+Ler5mW88vbT/UvRPrCHQKC22dw10oBcIhcSoEbif6M=; b=Y7wtTOIMsh8f0nrw33scWpInqfxxA2todWPAO/a8bam/AjbAHATd6/V+QHq7vMIsEh YEaOiDaSYC3kZ0I2H293+pAH98UrcIl6hUfax+m4gp/5lCe6bm3r1ZMI3+VINa33C40r BVy3ny/V6F9OwAd/hM2F9IzCZbp9fldZEW7VtKnjX8qj5lKyFyY5ySrmoyKYauRN3wLL w8zDGbknr0nY+wPdGlYF6XV1q11QD61/0Ek9aYVRcAEfsX0ZeKpSBIg+HGRZSN7lIGKq f6PAErSQ2XhkFulnVEkVopnRtfJdv9OTb7qonvliIvizSwxT8t8BiCXFjvTxYtT4/1Eg IdbQ==
X-Gm-Message-State: AOAM533eKSzTer9p/oHR/Dm9AKY505JsxFAtCCo2hkzwe57O8iL1YWu2 1X+OAjcrAnxRkjebniWmCIEuw0XHi3k7So7nzkc=
X-Google-Smtp-Source: ABdhPJwGVR4iGxgV8NNn0B18ZuKPHU/Clqa7T8OagczKhRHKSJP7kn8xJEWAz+yxjUo19IdkRS5cNZ0D8CNAi1tAym0=
X-Received: by 2002:a37:2796:: with SMTP id n144mr11032641qkn.57.1612651924242; Sat, 06 Feb 2021 14:52:04 -0800 (PST)
MIME-Version: 1.0
References: <161240956258.5082.18097054694330751435@ietfa.amsl.com> <CAA=duU1c3g0qmNmSN9jpfq3o4Lggxg_vT3xLdmwxAzLPm0r-iQ@mail.gmail.com> <15878309-55BA-4BE0-BD26-060308BA1270@tzi.org> <E77A02FF-4DF8-4030-BC77-4355A705E00E@adobe.com> <A2CC3D3F-3920-4E51-AAD7-1FFE83CA5ECB@tzi.org> <18192.1612647870@localhost>
In-Reply-To: <18192.1612647870@localhost>
From: "Andrew G. Malis" <agmalis@gmail.com>
Date: Sat, 06 Feb 2021 17:51:48 -0500
Message-ID: <CAA=duU1vjuSRZWNdUq1Sw7rNKipipUgH=G9ippSB4p=1p5PqJg@mail.gmail.com>
To: Michael Richardson <mcr+ietf@sandelman.ca>
Cc: RFC Interest <rfc-interest@rfc-editor.org>, tools-discuss <tools-discuss@ietf.org>
Content-Type: multipart/alternative; boundary="00000000000017444805bab2c918"
Archived-At: <https://mailarchive.ietf.org/arch/msg/tools-discuss/Kt4tE_1E4chmGEoo7T2cUrkeeOM>
Subject: Re: [Tools-discuss] [rfc-i] Recommendation 9 from Results and analysis of the survey of I-D authors on formats and tools
X-BeenThere: tools-discuss@ietf.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: IETF Tools Discussion <tools-discuss.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/tools-discuss/>
List-Post: <mailto:tools-discuss@ietf.org>
List-Help: <mailto:tools-discuss-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/tools-discuss>, <mailto:tools-discuss-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sat, 06 Feb 2021 22:52:08 -0000

Michael,

You make some good points, thanks.

But also, I'm happy with Carsten's new idnits option, so this has been a
useful discussion.

Cheers,
Andy


On Sat, Feb 6, 2021 at 4:44 PM Michael Richardson <mcr+ietf@sandelman.ca>
wrote:

>
> I am agnostic about commonmark vs kramdown.
> I want to address the question of accepting markdown on the DT.
>
> There are three aspects which mis-recommends this to me:
> 1) DT would have to be able to communicate errors back to the submitter
> well.
>    Running the formatting, including the xml2rfc pass locally means that
>    errors are communicating locally.
>    So, my opinion is that accepting kramdown does not reduce any local
> complexity.
>
> 2) {::include }
>    One of the things I like about kramdown, is the {:include} directive.
>    This lets us keep the ascii art and other example diagrams in other
> files.
>    This significantly reduces errors in updating example content.
>
>    If we supported upload in kramdown, then we'd have to support upload
>    of entire sets of files to be useful.
>
> 3) {::include } is insufficient.
>    We have a bunch of other content: code examples, yang modules,  etc.
>    which have so far been rather annoying to get in, and I wrote a perl
>    script to insert the right <CODE BEGINS>, <figure><artwork>, and
>    also to pick the right YANG version YYYYMMDD stuff.
>
>    I think that getting all this right in whatever markdown format would
>    take several iteration of tool improvements, and we have only just
>    gotten to XMLv3.
>    XMLv3 gets this all 'right' now, but I think that we aren't even close
>    to 100% submission as XML.
>
> --
> Michael Richardson <mcr+IETF@sandelman.ca>   . o O ( IPv6 IøT consulting )
>            Sandelman Software Works Inc, Ottawa and Worldwide
> _______________________________________________
> rfc-interest mailing list
> rfc-interest@rfc-editor.org
> https://www.rfc-editor.org/mailman/listinfo/rfc-interest
>