Re: [netmod] WG adoption poll draft-lhotka-netmod-yang-markup-00

Jonathan Hansford <jonathan@hansfords.net> Fri, 21 April 2017 11:14 UTC

Return-Path: <jonathan@hansfords.net>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 6E348129C71; Fri, 21 Apr 2017 04:14:52 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.988
X-Spam-Level:
X-Spam-Status: No, score=-1.988 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, T_SPF_PERMERROR=0.01, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=hansfords.net
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 0VvCCBN2VF80; Fri, 21 Apr 2017 04:14:49 -0700 (PDT)
Received: from server.myfast.site (server.myfast.site [212.113.130.90]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C423F129C51; Fri, 21 Apr 2017 04:14:49 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=hansfords.net; s=default; h=Content-Type:MIME-Version:Subject:References: In-Reply-To:Message-ID:Cc:To:From:Date:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=m66P82nOodKIb6ZmNS0fDE/E9x7yESqdc5OEh4IAPcA=; b=c50Gv8cS0TuRvjhDvYXx2ZxRJ Hcjn2xd9HlNX+Hlgzd4eHoG9zlF2tzUq1J+HGjrrYPZ35bB0en2UCDxYDXsqKSncZbISEiqG7xYis xIG1hLYMKll+DHbGbLX2+WBMyoKWdrwAacdURUjAWQlunO795zzmgDW8nw6QL/IzWm2th6w8TBXYN WUqUCVRYmq2sRcvthzAPnvZ/Mz89qhRXA7UU/mXpUAUlivu7n5pqTsw9SKYUWoDhgn1O+yozhOLpD uZKsKYxLGFi5tkyduryMD+zaHJSPQlvut3mAo9V+TRXEQWgDHKGi+vfSVrtvnbfNk3uMKjz+nC+uF jvT8sI0PQ==;
Received: from [84.92.116.209] (port=51038 helo=[192.168.1.24]) by server.myfast.site with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.89) (envelope-from <jonathan@hansfords.net>) id 1d1WWT-000A4B-QZ; Fri, 21 Apr 2017 12:14:45 +0100
Date: Fri, 21 Apr 2017 12:14:33 +0100
From: Jonathan Hansford <jonathan@hansfords.net>
To: Ladislav Lhotka <lhotka@nic.cz>, Phil Shafer <phil@juniper.net>, Andy Bierman <andy@yumaworks.com>, Kent Watsen <kwatsen@juniper.net>
Cc: NetMod WG Chairs <netmod-chairs@ietf.org>, NETMOD WG <netmod@ietf.org>
Message-ID: <55a8f526-c507-4a26-9dff-ef9f06837445@Spark>
In-Reply-To: <A2B09A4C-2279-40E3-B991-34086F7BE210@juniper.net>
References: <201704181720.v3IHKCJ7045659@idle.juniper.net> <m2k26g68qa.fsf@nic.cz> <A2B09A4C-2279-40E3-B991-34086F7BE210@juniper.net>
X-Readdle-Message-ID: 55a8f526-c507-4a26-9dff-ef9f06837445@Spark
MIME-Version: 1.0
Content-Type: multipart/alternative; boundary="58f9e9a5_327b23c6_d3"
X-AntiAbuse: This header was added to track abuse, please include it with any abuse report
X-AntiAbuse: Primary Hostname - server.myfast.site
X-AntiAbuse: Original Domain - ietf.org
X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12]
X-AntiAbuse: Sender Address Domain - hansfords.net
X-Get-Message-Sender-Via: server.myfast.site: authenticated_id: jonathan@hansfords.net
X-Authenticated-Sender: server.myfast.site: jonathan@hansfords.net
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/s3BpklaEpM59-Pdw_o1SDVOd3pM>
Subject: Re: [netmod] WG adoption poll draft-lhotka-netmod-yang-markup-00
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 21 Apr 2017 11:14:52 -0000

I understand the primary need is to make the YANG modules accessible to readers, but some simple markup is identical to how text might be formatted when only raw ASCII is available (e.g. when using a simple email client) yet, when rendered as markup, the resulting text is easier on the eyes of the reader.

I agree that some examples may better sell the idea.

Also, if some YANG authors are already including markup, wouldn't it be better to standardise rather than allow for a free-for-all resulting in multiple styles that would impose a significant burden on any tool trying to render the text.

Jonathan

=O)

On 19 Apr 2017, 22:05 +0100, Kent Watsen <kwatsen@juniper.net>, wrote:
>
> All,
>
> We're a couple days away from the 2-week window. As of now, the
> majority does not support adopting this draft. Any remaining
> opinions?
>
>
> Lada,
>
> The objections seem to be concern for net readability, and for the
> importance of the problem relative to other activities. For the
> former case, it may help if you posted some examples. For the
> latter case, we may want to keep this draft cooking in the
> background.
>
>
> Kent // as co-chair and potential shepherd
>
>
>
> Phil Shafer <phil@juniper.net> writes:
>
> > Andy Bierman writes:
> > > IMO it is more robust not to assume people never see the real YANG
> > > statements.
> >
> > Exactly. We made YANG readable so that we wouldn't _need_ to view
> > it using tools. This was one of the "insta-death" factors for UML.
>
> I have to reiterate that the idea is to continue to be able to view YANG
> modules *without* using tools, but provide some aid to tools that can make
> use of certain well-defined lightweight markup conventions.
>
> Everybody with a practical experience of converting YANG automatically
> to something else (not only to HTML, it starts already with YIN) knows
> that transferring descriptions and other similar texts is tricky.
>
> Lada
>
> >
> > Thanks,
> > Phil
> >
> > _______________________________________________
> > netmod mailing list
> > netmod@ietf.org
> > https://www.ietf.org/mailman/listinfo/netmod
>
> --
> Ladislav Lhotka, CZ.NIC Labs
> PGP Key ID: 0xB8F92B08A9F76C67
>
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod
>
>
> _______________________________________________
> netmod mailing list
> netmod@ietf.org
> https://www.ietf.org/mailman/listinfo/netmod