Re: [netmod] I-D Action: draft-ietf-netmod-yang-tree-diagrams-02.txt size

Lou Berger <lberger@labn.net> Fri, 27 October 2017 10:00 UTC

Return-Path: <lberger@labn.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 623D913B138 for <netmod@ietfa.amsl.com>; Fri, 27 Oct 2017 03:00:58 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.201
X-Spam-Level:
X-Spam-Status: No, score=-4.201 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-2.8, RCVD_IN_SORBS_SPAM=0.5, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (768-bit key) header.d=labn.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 FFO8fpQlygzV for <netmod@ietfa.amsl.com>; Fri, 27 Oct 2017 03:00:56 -0700 (PDT)
Received: from gproxy2-pub.mail.unifiedlayer.com (gproxy2-pub.mail.unifiedlayer.com [69.89.18.3]) (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 33B5B13AB12 for <netmod@ietf.org>; Fri, 27 Oct 2017 03:00:56 -0700 (PDT)
Received: from cmgw4 (unknown [10.0.90.85]) by gproxy2.mail.unifiedlayer.com (Postfix) with ESMTP id 9A0171E0EC7 for <netmod@ietf.org>; Fri, 27 Oct 2017 04:00:55 -0600 (MDT)
Received: from box313.bluehost.com ([69.89.31.113]) by cmgw4 with id Sa0s1w00Z2SSUrH01a0vbn; Fri, 27 Oct 2017 04:00:55 -0600
X-Authority-Analysis: v=2.2 cv=JNNLi4Cb c=1 sm=1 tr=0 a=h1BC+oY+fLhyFmnTBx92Jg==:117 a=h1BC+oY+fLhyFmnTBx92Jg==:17 a=kj9zAlcOel0A:10 a=02M-m0pO-4AA:10 a=j3Z76cjpAAAA:8 a=c4zLxNkgn3jE6x304_QA:9 a=CjuIK1q_8ugA:10 a=FvgKqOQ44qUA:10 a=JrSEOxZJtCQA:10 a=9ZYBcOd_X9kS2t7VFny2:22
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=labn.net; s=default; h=Content-Transfer-Encoding:Content-Type:MIME-Version:Subject: References:In-Reply-To:Message-ID:Date:CC:To:From:Sender:Reply-To: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=6AmzWsnf99+EGRNtxBdRfEuNNM7ALhSCR17xW2kX2y0=; b=Diu5iFN7xCrjeP/k+AHHQ4bf2L Q4Isn5gbxFv04duCo7aTBay1URwRL4aIE04+eFffEJnGAT56L2vJ08w6UDQ2kZh4WMC8N9907YvGh pT47O5iJi4rtfAdM3+9Y5SefK;
Received: from pool-100-15-86-101.washdc.fios.verizon.net ([100.15.86.101]:54148 helo=[11.4.0.163]) by box313.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.87) (envelope-from <lberger@labn.net>) id 1e81Rb-000H8d-U9; Fri, 27 Oct 2017 04:00:52 -0600
From: Lou Berger <lberger@labn.net>
To: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
CC: "t.petch" <ietfc@btconnect.com>, <netmod@ietf.org>
Date: Fri, 27 Oct 2017 06:00:50 -0400
Message-ID: <15f5d46ec50.27d3.9b4188e636579690ba6c69f2c8a0f1fd@labn.net>
In-Reply-To: <20171026234123.pt65l6ctgmx2hd55@elstar.local>
References: <150893578927.4882.2117597388624976982@ietfa.amsl.com> <23892572-a0db-d24b-e591-a19799ace9ae@labn.net> <010301d34e7b$1d5303c0$4001a8c0@gateway.2wire.net> <d592e9c4-21c8-16d5-a0a9-f6ce54cd31da@labn.net> <20171026221736.cl3kpzo2i7zaa4qh@elstar.local> <3cb344fe-2d49-3fd1-90ad-e6ffe0734dc7@labn.net> <20171026234123.pt65l6ctgmx2hd55@elstar.local>
User-Agent: AquaMail/1.11.0-568 (build: 101100004)
MIME-Version: 1.0
Content-Type: text/plain; format=flowed; charset="us-ascii"
Content-Transfer-Encoding: 8bit
X-AntiAbuse: This header was added to track abuse, please include it with any abuse report
X-AntiAbuse: Primary Hostname - box313.bluehost.com
X-AntiAbuse: Original Domain - ietf.org
X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12]
X-AntiAbuse: Sender Address Domain - labn.net
X-BWhitelist: no
X-Source-IP: 100.15.86.101
X-Exim-ID: 1e81Rb-000H8d-U9
X-Source:
X-Source-Args:
X-Source-Dir:
X-Source-Sender: pool-100-15-86-101.washdc.fios.verizon.net ([11.4.0.163]) [100.15.86.101]:54148
X-Source-Auth: lberger@labn.net
X-Email-Count: 1
X-Source-Cap: bGFibm1vYmk7bGFibm1vYmk7Ym94MzEzLmJsdWVob3N0LmNvbQ==
X-Local-Domain: yes
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/uXBJjYijjW-nUtBj1bRq3Acb3qo>
Subject: Re: [netmod] I-D Action: draft-ietf-netmod-yang-tree-diagrams-02.txt size
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, 27 Oct 2017 10:00:58 -0000

Juergen,



On October 26, 2017 7:43:18 PM Juergen Schoenwaelder 
<j.schoenwaelder@jacobs-university.de> wrote:

> On Thu, Oct 26, 2017 at 07:03:11PM -0400, Lou Berger wrote:
>>
>>    As tree diagrams are intended to provide a simplified view of a
>>    module, diagrams longer than a page should generally be avoided.  If
>>    the complete tree diagram for a module becomes too long, the diagram
>>    can be split into several smaller diagrams.  For example, it might be
>>    possible to have one diagram with the data node and another with all
>>    notifications.  If the data nodes tree is too long, it is also
>>    possible to split the diagram into smaller diagrams for different
>>    subtrees.  When long diagrams are included in a document, authors
>>    should consider whether to include the long diagram in the main body
>>    of the document or in an appendix.
>>
>>
>> again, please suggest improvements.
>>
>
> Remove the last sentence. Moving lengthy diagrams to an appendix does
> not help the reader.
>

Keep in mind this is guidance, so autos may include a long tree even if the 
text says don't.  So what do you want them to do if they decide they really 
want a many page tree? leave the long tree in the body???

Lou


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