Re: [yang-doctors] automating yang doctor reviews

Benoit Claise <bclaise@cisco.com> Mon, 23 April 2018 20:48 UTC

Return-Path: <bclaise@cisco.com>
X-Original-To: yang-doctors@ietfa.amsl.com
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 7D69212D957 for <yang-doctors@ietfa.amsl.com>; Mon, 23 Apr 2018 13:48:58 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.511
X-Spam-Level:
X-Spam-Status: No, score=-14.511 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, T_DKIMWL_WL_HIGH=-0.01, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.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 AlKPcFLVJMJr for <yang-doctors@ietfa.amsl.com>; Mon, 23 Apr 2018 13:48:56 -0700 (PDT)
Received: from aer-iport-4.cisco.com (aer-iport-4.cisco.com [173.38.203.54]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 3209412D956 for <yang-doctors@ietf.org>; Mon, 23 Apr 2018 13:48:56 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=2935; q=dns/txt; s=iport; t=1524516536; x=1525726136; h=subject:to:references:from:message-id:date:mime-version: in-reply-to:content-transfer-encoding; bh=sN6jXhwYo+DlnnxRHA8lWc48vxW+/3J4oqcaZmCFfSU=; b=UVCsoTjqZdoeupGUH1BYDTLXCqXkBVGNMbXnxaCP3JH3ct5HcqkHOXzy HWXFBAHrbJFWTD3g2ZozZjkn8sx2spdPZxx7A4vj5KcMUBO3r5Xcr+hwE B07N1ey/nmUNIa71/JftjQtqpvB6hQM82Du/utULkjgqcDDEkTuHDnfwY 0=;
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0D8BAA0Rt5a/xbLJq1dHAEBAQQBAQo?= =?us-ascii?q?BAYQkeiiDaohgjWUpgQ+TAIF4CxgLhEgCgwg1FwECAQEBAQEBAmwcDIUjAQE?= =?us-ascii?q?BAwEBIRU2GwsOCgICJgICJzAGAQwGAgEBhQsPqFuCHIRYg22CNAWBCYhXP4E?= =?us-ascii?q?ygmiDEQEBgWAsglSCNCACjAaLbQiOOgaFY4FnhQSLDIUhgSUeAzOBUjMaCBs?= =?us-ascii?q?VO4JDixCFQD0wjhorghkBAQ?=
X-IronPort-AV: E=Sophos;i="5.49,319,1520899200"; d="scan'208";a="3313515"
Received: from aer-iport-nat.cisco.com (HELO aer-core-4.cisco.com) ([173.38.203.22]) by aer-iport-4.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 23 Apr 2018 20:48:52 +0000
Received: from [10.55.221.36] (ams-bclaise-nitro3.cisco.com [10.55.221.36]) by aer-core-4.cisco.com (8.14.5/8.14.5) with ESMTP id w3NKmqQ8002429; Mon, 23 Apr 2018 20:48:52 GMT
To: Kent Watsen <kwatsen@juniper.net>, "yang-doctors@ietf.org" <yang-doctors@ietf.org>
References: <51E10A3A-FF6F-4A14-AAD6-BBD12041EF2F@juniper.net> <20180423202511.omhs22xnios3itjw@elstar.local>
From: Benoit Claise <bclaise@cisco.com>
Message-ID: <5d49f2cb-6ed6-232c-6b96-ec2d0bd69d32@cisco.com>
Date: Mon, 23 Apr 2018 22:48:52 +0200
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.7.0
MIME-Version: 1.0
In-Reply-To: <20180423202511.omhs22xnios3itjw@elstar.local>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/RiekMlTql8R924F0f1rzV08-R9w>
Subject: Re: [yang-doctors] automating yang doctor reviews
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Mon, 23 Apr 2018 20:48:58 -0000

On 4/23/2018 10:25 PM, Juergen Schoenwaelder wrote:
> Kent,
>
> it seems that many of us manage several artefacts while producing an
> I-D (that is the .xml that is then rendered as an I-D).
>
> a) YANG modules
> b) derived artefacts such as tree diagrams
> c) examples snippets (XML or JSON)
> d) source of textual information (growing variety of formats used here)
> e) tooling to validate examples and YANG modules
> f) tooling to produce .xml out of a)-d)
>
> What you are proposing, if I understand correctly, is to extend the
> xml2rfc vocabulary such that we can reverse step f), at least
> partially, to extract a) and c) out of the xml2rfc format and perhaps
> generate b) automatically from a) and then do e) within the IETF
> infrastructure. I am not sure I am excited about turning a document
> markup format (xml2rfc) into a general container format and perhaps
> also into a (scriptable) data transformation format. (But yes, it
> sound much better than what we do today, extracting artefacts out of
> rendered and paginated text.)
>
> Perhaps things could be simpler if authors would be able to submit all
> pieces that make up an I-D as separate artefacts instead of first
> inlining all of the artefacts in some xml2rfc container format and
> then extracting them again out of this format to feed tool chains.
Exactly.
That way, we could add more example snippets, even after the publication.

Regards, Benoit
>
> The whole idea that a document is a single file using a single format
> really feels somewhat odd these days. (Well, it already felt odd when
> people were writing MIB modules and the RFC editor used nroff or plain
> text to start their editing. The pain isn't new, just coming along in
> a different flavor.)
>
> Perhaps all we need is a proper sourcecode include mechanism and a
> submission tool that allows to submit multiple artefacts so we do not
> need to first inline everything into xml2rfc and then extract things
> out of it again.
>
> /js
>
> On Mon, Apr 23, 2018 at 06:40:30PM +0000, Kent Watsen wrote:
>> anyone interested in this draft?  (draft attached in my previous message)
>>
>> /kw
>>
>>
>> ===== original message =====
>>
>> Doctors,
>>
>> Here's a stab at how we might automate the basic parts of a YANG Doctor review, something I've mentioned wanting at the YD-lunch meeting at the last two IETF meetings.
>>
>> I'll be the first to say that this proposal has issues, but hopefully it's in the ballpark, and we can finish it off together, assuming there is interest in bringing it forward at all...
>>
>> Note, I assume that this document will be AD-sponsored, just like RFC 7991 was, hence why the draft name is what it is.
>>
>> Kent
>>   
>>
>>
>>
>> _______________________________________________
>> yang-doctors mailing list
>> yang-doctors@ietf.org
>> https://www.ietf.org/mailman/listinfo/yang-doctors