Re: [yang-doctors] automating yang doctor reviews

Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de> Mon, 23 April 2018 20:25 UTC

Return-Path: <j.schoenwaelder@jacobs-university.de>
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 35B0D12D946 for <yang-doctors@ietfa.amsl.com>; Mon, 23 Apr 2018 13:25:16 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.9
X-Spam-Level:
X-Spam-Status: No, score=-1.9 tagged_above=-999 required=5 tests=[BAYES_00=-1.9] 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 rpv4Rj5gZjVm for <yang-doctors@ietfa.amsl.com>; Mon, 23 Apr 2018 13:25:13 -0700 (PDT)
Received: from atlas5.jacobs-university.de (atlas5.jacobs-university.de [212.201.44.20]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 86177126CBF for <yang-doctors@ietf.org>; Mon, 23 Apr 2018 13:25:13 -0700 (PDT)
Received: from localhost (demetrius5.irc-it.jacobs-university.de [10.70.0.222]) by atlas5.jacobs-university.de (Postfix) with ESMTP id 57D7DCF6; Mon, 23 Apr 2018 22:25:12 +0200 (CEST)
X-Virus-Scanned: amavisd-new at jacobs-university.de
Received: from atlas5.jacobs-university.de ([10.70.0.217]) by localhost (demetrius5.jacobs-university.de [10.70.0.222]) (amavisd-new, port 10032) with ESMTP id yEzbiQAr9_-N; Mon, 23 Apr 2018 22:25:11 +0200 (CEST)
Received: from hermes.jacobs-university.de (hermes.jacobs-university.de [212.201.44.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "hermes.jacobs-university.de", Issuer "Jacobs University CA - G01" (verified OK)) by atlas5.jacobs-university.de (Postfix) with ESMTPS; Mon, 23 Apr 2018 22:25:12 +0200 (CEST)
Received: from localhost (demetrius4.jacobs-university.de [212.201.44.49]) by hermes.jacobs-university.de (Postfix) with ESMTP id 2EEF420035; Mon, 23 Apr 2018 22:25:12 +0200 (CEST)
X-Virus-Scanned: amavisd-new at jacobs-university.de
Received: from hermes.jacobs-university.de ([212.201.44.23]) by localhost (demetrius4.jacobs-university.de [212.201.44.32]) (amavisd-new, port 10024) with ESMTP id h9gd3Ixs8Eqx; Mon, 23 Apr 2018 22:25:11 +0200 (CEST)
Received: from elstar.local (unknown [10.50.231.133]) by hermes.jacobs-university.de (Postfix) with ESMTP id 9A33720031; Mon, 23 Apr 2018 22:25:11 +0200 (CEST)
Received: by elstar.local (Postfix, from userid 501) id 2F87E42BE14C; Mon, 23 Apr 2018 22:25:11 +0200 (CEST)
Date: Mon, 23 Apr 2018 22:25:11 +0200
From: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
To: Kent Watsen <kwatsen@juniper.net>
Cc: "yang-doctors@ietf.org" <yang-doctors@ietf.org>
Message-ID: <20180423202511.omhs22xnios3itjw@elstar.local>
Reply-To: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
Mail-Followup-To: Kent Watsen <kwatsen@juniper.net>, "yang-doctors@ietf.org" <yang-doctors@ietf.org>
References: <51E10A3A-FF6F-4A14-AAD6-BBD12041EF2F@juniper.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <51E10A3A-FF6F-4A14-AAD6-BBD12041EF2F@juniper.net>
User-Agent: NeoMutt/20171215
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/IRU-Fz5i2fYrFxFaPQLoB5cHV4g>
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:25:16 -0000

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.

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

-- 
Juergen Schoenwaelder           Jacobs University Bremen gGmbH
Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
Fax:   +49 421 200 3103         <https://www.jacobs-university.de/>