[netmod] Status update on <draft-wu-netmod-yang-xml-doc-conventions-01>

Qin Wu <bill.wu@huawei.com> Wed, 30 May 2018 01:39 UTC

Return-Path: <bill.wu@huawei.com>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost []) by ietfa.amsl.com (Postfix) with ESMTP id 9EF2912F092 for <netmod@ietfa.amsl.com>; Tue, 29 May 2018 18:39:59 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.201
X-Spam-Status: No, score=-4.201 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Received: from mail.ietf.org ([]) by localhost (ietfa.amsl.com []) (amavisd-new, port 10024) with ESMTP id b2f3YSq8qHZV for <netmod@ietfa.amsl.com>; Tue, 29 May 2018 18:39:57 -0700 (PDT)
Received: from huawei.com (lhrrgout.huawei.com []) (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 A7DBB12ECEB for <netmod@ietf.org>; Tue, 29 May 2018 18:39:57 -0700 (PDT)
Received: from LHREML714-CAH.china.huawei.com (unknown []) by Forcepoint Email with ESMTP id A2EEB969DCED1 for <netmod@ietf.org>; Wed, 30 May 2018 02:39:53 +0100 (IST)
Received: from NKGEML413-HUB.china.huawei.com ( by LHREML714-CAH.china.huawei.com ( with Microsoft SMTP Server (TLS) id 14.3.382.0; Wed, 30 May 2018 02:39:54 +0100
Received: from NKGEML513-MBX.china.huawei.com ([]) by NKGEML413-HUB.china.huawei.com ([]) with mapi id 14.03.0382.000; Wed, 30 May 2018 09:39:43 +0800
From: Qin Wu <bill.wu@huawei.com>
To: "netmod@ietf.org" <netmod@ietf.org>
Thread-Topic: Status update on <draft-wu-netmod-yang-xml-doc-conventions-01>
Thread-Index: AQHT97P2/JSg9j4OKEuGkK1Py+kz/KRHeJEA
Date: Wed, 30 May 2018 01:39:42 +0000
Message-ID: <B8F9A780D330094D99AF023C5877DABA9AE913E4@nkgeml513-mbx.china.huawei.com>
Accept-Language: zh-CN, en-US
Content-Language: zh-CN
x-originating-ip: []
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-CFilter-Loop: Reflected
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/-nroHdV6vC91kJIkPyl9ZtWS-g8>
Subject: [netmod] Status update on <draft-wu-netmod-yang-xml-doc-conventions-01>
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: Wed, 30 May 2018 01:40:00 -0000

Hi, WG:
We have made an update Documentation Conventions for Expressing YANG in XML I-D based on last meeting discussion.
The changes include:
1. Add JSON support.
2. Add objectives section 
3. Consolidate Mandatory Boilerplate for both leaf node and metadata annotation.
4. Move complex case to Appendix.
5. Better Align abstract and introduction section with objectives sections.
The diff is:
We believe the v-(01) address all the comments in last meeting and can serve a good basis to move to the next step.
Thanks. Further Comments and suggestions are welcome.

发件人: internet-drafts@ietf.org [mailto:internet-drafts@ietf.org] 
发送时间: 2018年5月30日 9:17
收件人: Benoit Claise; Qin Wu; Adrian Farrel; Benoît Claise
主题: New Version Notification for draft-wu-netmod-yang-xml-doc-conventions-01.txt

A new version of I-D, draft-wu-netmod-yang-xml-doc-conventions-01.txt
has been successfully submitted by Qin Wu and posted to the IETF repository.

Name:		draft-wu-netmod-yang-xml-doc-conventions
Revision:	01
Title:		Documentation Conventions for Expressing YANG in XML
Document date:	2018-05-29
Group:		Individual Submission
Pages:		10
URL:            https://www.ietf.org/internet-drafts/draft-wu-netmod-yang-xml-doc-conventions-01.txt
Status:         https://datatracker.ietf.org/doc/draft-wu-netmod-yang-xml-doc-conventions/
Htmlized:       https://tools.ietf.org/html/draft-wu-netmod-yang-xml-doc-conventions-01
Htmlized:       https://datatracker.ietf.org/doc/html/draft-wu-netmod-yang-xml-doc-conventions
Diff:           https://www.ietf.org/rfcdiff?url2=draft-wu-netmod-yang-xml-doc-conventions-01

   Many documents that define YANG modules also include artwork examples
   presented in XML/JSON.

   IETF documentation has specific limits on line length and some
   artwork examples such as XML examples have to include line wraps that
   would not normally be allowed according to the XML representation
   rules of RFC7950 and RFC7952.The same applies to JSON.

   This document lays out documentation conventions that allow YANG
   examples to be presented in IETF documentation when XML/JSON encoded
   YANG data instance would otherwise exceed the maximum line length and
   provide consistent XML/JSON encoded YANG data node instance example
   within an Internet-Draft or RFC.  There are no implications in this
   document for YANG parsers: this document does not change the rules
   for presenting YANG models or for encoding YANG in data files or in
   the wire.


Please note that it may take a couple of minutes from the time of submission until the htmlized version and diff are available at tools.ietf.org.

The IETF Secretariat