Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-05 Thread Xufeng Liu
Hi Med and all,

Sorry that I would not agree with the proposed text, especially the
following:

   "If the complete

   tree diagram is too long (more than 5 pages, typically) even with

   groupings unexpanded (Section 2.2 of [RFC8340]), the authors SHOULD

   NOT include it in the document.  A stable pointer to retrieve the

   full tree MAY be included."

I agree with Chris, Italto, and Andy on the usefulness of the full,
complete YANG trees presented in the document.


A tree provided by a "stable pointer" is not a complete substitute for the
tree embedded in the document:

1) A "stable pointer" site (such as the YANG Catalog) builds the tree with
different versions of dependencies (usually the latest versions at the time
of browsing), while the embedded tree view is built with the versions of
dependencies available at the time when the document is published. The
embedded tree view provides the context of the model design at that
particular point in time.

2) A "stable pointer" site (such as the YANG Catalog) may present the tree
in a format different from RFC8340. In many use cases, it is useful and
convenient to browse the tree in collapsable and clickable web pages, but
in other cases when we want to have a plain-text tree (or a portion of the
tree) in the RFC8340 format, it is not convenient to use such a web site.

In addition, I am not convinced by the following:

  "The full tree diagram of the module can be generated using,

  e.g., the "pyang" tool. That tree is not included here because

  it is too long."

For casual readers setting up "pyang" is not a convenient way to consume
the document, especially when the YANG module has many imported
dependencies. It would be even harder to reproduce the tree snapshot
reflecting the point in time when the document was published.

Having a similar experience as Italo described, I would prefer:
1) Every document includes a full, complete tree view;
2) If the tree view is long, it can be put in an appendix;
3) If the tree view contains naturally separated pieces (such as separate
augmentation trees), the lossless tree pieces can be put into subsections
of the document.

Thanks,
- Xufeng

<https://www.avast.com/sig-email?utm_medium=email_source=link_campaign=sig-email_content=webmail>
Virus-free.www.avast.com
<https://www.avast.com/sig-email?utm_medium=email_source=link_campaign=sig-email_content=webmail>
<#m_-9098914578306838048_DAB4FAD8-2DD7-40BB-A1B8-4E2AA1F9FDF2>

On Tue, Mar 5, 2024 at 5:08 PM Andy Bierman  wrote:

>
>
> On Tue, Mar 5, 2024 at 1:47 PM Kent Watsen  wrote:
>
>> In addition to improving IETF-published artifacts, it would be nice if
>> there were a module-browser that acted a little bit like an IDE, jumping to
>> where in other modules imported bits are defined.  Perhaps in
>> NetconfCentral or YANG Catalog.  This jumping behavior could exist in both
>> the text and tree-diagram views.
>>
>>
>
> I like the plain-text full tree diagram that is usually present before the
> YANG module.
> Often the groupings and typedefs are from external modules, and/or are
> difficult to figure out.
> Yet the groupings and typedefs must be found and read to understand the
> model.
>
> It would be nice if the HTML version of the draft/RFC had links in the
> tree diagram to the actual YANG statements.
>
> DRY vs. WET: the structure of a YANG module (i.e. dividing into sections)
> is too complex have strict rules.
> A tree diagram for the definitions relevant to each section is usually
> helpful, in addition to the full tree diagram.
> I would avoid SHOULD and SHOULD NOT for this issue.
>
>
>
>> K.
>>
>
> Andy
>
>
>>
>>
>> On Mar 5, 2024, at 11:21 AM, Italo Busi > 40huawei@dmarc.ietf.org> wrote:
>>
>> I like the idea of relying on tooling with hyperlinks
>>
>>
>>
>> For txt and pdf, I agree that a link is the best option since these
>> formats are not optimized for including YANG trees
>>
>> Italo
>>
>>
>>
>> *From:* Kent Watsen 
>> *Sent:* martedì 5 marzo 2024 16:02
>> *To:* mohamed.boucad...@orange.com
>> *Cc:* Italo Busi ; Qin Wu ;
>> Mahesh Jethanandani ; netmod@ietf.org
>> *Subject:* Re: [netmod] Long trees RE: Next steps for
>> draft-ietf-netmod-rfc8407bis
>>
>>
>>
>>
>>
>> It seems that there are two camps:
>>
>>
>>
>> 1) those that want the tree-diagrams to be as DRY as possible
>>
>> 2) those that want the tree-diagrams to be as WET as possible
>>
>>
>>
>>   DRY = Don't Repeat Yourself
>>
>>  

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-05 Thread Andy Bierman
On Tue, Mar 5, 2024 at 1:47 PM Kent Watsen  wrote:

> In addition to improving IETF-published artifacts, it would be nice if
> there were a module-browser that acted a little bit like an IDE, jumping to
> where in other modules imported bits are defined.  Perhaps in
> NetconfCentral or YANG Catalog.  This jumping behavior could exist in both
> the text and tree-diagram views.
>
>

I like the plain-text full tree diagram that is usually present before the
YANG module.
Often the groupings and typedefs are from external modules, and/or are
difficult to figure out.
Yet the groupings and typedefs must be found and read to understand the
model.

It would be nice if the HTML version of the draft/RFC had links in the tree
diagram to the actual YANG statements.

DRY vs. WET: the structure of a YANG module (i.e. dividing into sections)
is too complex have strict rules.
A tree diagram for the definitions relevant to each section is usually
helpful, in addition to the full tree diagram.
I would avoid SHOULD and SHOULD NOT for this issue.



> K.
>

Andy


>
>
> On Mar 5, 2024, at 11:21 AM, Italo Busi  40huawei@dmarc.ietf.org> wrote:
>
> I like the idea of relying on tooling with hyperlinks
>
>
>
> For txt and pdf, I agree that a link is the best option since these
> formats are not optimized for including YANG trees
>
> Italo
>
>
>
> *From:* Kent Watsen 
> *Sent:* martedì 5 marzo 2024 16:02
> *To:* mohamed.boucad...@orange.com
> *Cc:* Italo Busi ; Qin Wu ;
> Mahesh Jethanandani ; netmod@ietf.org
> *Subject:* Re: [netmod] Long trees RE: Next steps for
> draft-ietf-netmod-rfc8407bis
>
>
>
>
>
> It seems that there are two camps:
>
>
>
> 1) those that want the tree-diagrams to be as DRY as possible
>
> 2) those that want the tree-diagrams to be as WET as possible
>
>
>
>   DRY = Don't Repeat Yourself
>
>   WET = Write Every Time
>
>
>
> Tooling can help both cases.
>
>
>
> For (1), the tree-diagrams are unexpanded, but surrounding text should
> point to where each used-grouping is defined.   The better tooling-assisted
> approach, is for the used groupings *inside the tree-diagram” to become
> hyperlinks (only possible in supporting formats).   Extending this idea
> further, hyperlinks could be provided for typedefs and identities too.
>
>
>
> For (2), for plain-text and PDF formats, a link to where the image can be
> accessed would be nice.  For the HTML format, inlining the complete
> (unfolded) tree-diagram with horizontal-scrolling would be ideal.
>
>
>
> Kent
>
>
>
>
>
> On Mar 5, 2024, at 3:01 AM, mohamed.boucad...@orange.com wrote:
>
>
>
> Hi Italo,
>
>
>
> Thanks for sharing your thoughts.
>
>
>
> Please see inline.
>
>
>
> Cheers,
>
> Med
>
>
>
> *De :* Italo Busi 
> *Envoyé :* lundi 4 mars 2024 19:38
> *À :* Qin Wu ; Mahesh Jethanandani <
> mjethanand...@gmail.com>; BOUCADAIR Mohamed INNOV/NET <
> mohamed.boucad...@orange.com>
> *Cc :* netmod@ietf.org
> *Objet :* RE: [netmod] Long trees RE: Next steps for
> draft-ietf-netmod-rfc8407bis
>
>
>
> Hi Med,
>
>
>
> In my personal experience, I have found the YANG tree included in the IETF
> RFCs/I-Ds useful only when they are complete, even if they are too long
>
> *[Med] I agree that having readily available full trees is useful, however
> the question is whether it should be embedded in the RFC text or would
> having stable links to access such trees be much more convenient? Note also
> that when the tree is too long, there are better places to display them for
> better user experience (control views, etc.), which we don’t have with the
> txt version.*
>
>
>
> In RFC8795 you can find an example of a too-long YANG tree which I am
> using quite often
>
>
>
> *[Med] If the Datatracker includes a link to the tree or 8795 includes a
> stable pointer to the full tree without the editing limitations of IETF
> docs, the experience would be the same, if not better. No?*
>
>
>
>
>
> I have found YANG trees with unexpanded grouping almost impossible to use.
> In draft-ietf-teas-yang-te you can find an example of a YANG tree with
> unexpanded grouping which I am not using at all. In this case, I refer to
> the YANG catalog to get the complete tree
>
>
>
> *[Med] ACK.*
>
>
>
> I have also found the YANG tree pieces almost useless (even if much better
> than the YANG trees with unexpanded grouping) without some overview.
>
>
>
> *[Med] Not having an overview to describe the overall structure and help
> readers navigate among all

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-05 Thread Kent Watsen
In addition to improving IETF-published artifacts, it would be nice if there 
were a module-browser that acted a little bit like an IDE, jumping to where in 
other modules imported bits are defined.  Perhaps in NetconfCentral or YANG 
Catalog.  This jumping behavior could exist in both the text and tree-diagram 
views.

K.


> On Mar 5, 2024, at 11:21 AM, Italo Busi 
>  wrote:
> 
> I like the idea of relying on tooling with hyperlinks
>  
> For txt and pdf, I agree that a link is the best option since these formats 
> are not optimized for including YANG trees
> 
> Italo
>  
> From: Kent Watsen  
> Sent: martedì 5 marzo 2024 16:02
> To: mohamed.boucad...@orange.com
> Cc: Italo Busi ; Qin Wu ; Mahesh 
> Jethanandani ; netmod@ietf.org
> Subject: Re: [netmod] Long trees RE: Next steps for 
> draft-ietf-netmod-rfc8407bis
>  
>  
> It seems that there are two camps:
>  
> 1) those that want the tree-diagrams to be as DRY as possible
> 2) those that want the tree-diagrams to be as WET as possible
> 
> 
>   DRY = Don't Repeat Yourself
>   WET = Write Every Time
>  
> Tooling can help both cases.
>  
> For (1), the tree-diagrams are unexpanded, but surrounding text should point 
> to where each used-grouping is defined.   The better tooling-assisted 
> approach, is for the used groupings *inside the tree-diagram” to become 
> hyperlinks (only possible in supporting formats).   Extending this idea 
> further, hyperlinks could be provided for typedefs and identities too.
>  
> For (2), for plain-text and PDF formats, a link to where the image can be 
> accessed would be nice.  For the HTML format, inlining the complete 
> (unfolded) tree-diagram with horizontal-scrolling would be ideal.
>  
> Kent
>  
> 
> 
> On Mar 5, 2024, at 3:01 AM, mohamed.boucad...@orange.com 
> <mailto:mohamed.boucad...@orange.com> wrote:
>  
> Hi Italo,
>  
> Thanks for sharing your thoughts.
>  
> Please see inline.
>  
> Cheers,
> Med
>  
> De : Italo Busi mailto:italo.b...@huawei.com>>
> Envoyé : lundi 4 mars 2024 19:38
> À : Qin Wu mailto:bill...@huawei.com>>; Mahesh 
> Jethanandani mailto:mjethanand...@gmail.com>>; 
> BOUCADAIR Mohamed INNOV/NET  <mailto:mohamed.boucad...@orange.com>>
> Cc : netmod@ietf.org <mailto:netmod@ietf.org>
> Objet : RE: [netmod] Long trees RE: Next steps for 
> draft-ietf-netmod-rfc8407bis
>  
> Hi Med,
>  
> In my personal experience, I have found the YANG tree included in the IETF 
> RFCs/I-Ds useful only when they are complete, even if they are too long
> [Med] I agree that having readily available full trees is useful, however the 
> question is whether it should be embedded in the RFC text or would having 
> stable links to access such trees be much more convenient? Note also that 
> when the tree is too long, there are better places to display them for better 
> user experience (control views, etc.), which we don’t have with the txt 
> version.
>  
> In RFC8795 you can find an example of a too-long YANG tree which I am using 
> quite often
>  
> [Med] If the Datatracker includes a link to the tree or 8795 includes a 
> stable pointer to the full tree without the editing limitations of IETF docs, 
> the experience would be the same, if not better. No?
>  
>  
> I have found YANG trees with unexpanded grouping almost impossible to use. In 
> draft-ietf-teas-yang-te you can find an example of a YANG tree with 
> unexpanded grouping which I am not using at all. In this case, I refer to the 
> YANG catalog to get the complete tree
>  
> [Med] ACK.
>  
> I have also found the YANG tree pieces almost useless (even if much better 
> than the YANG trees with unexpanded grouping) without some overview.
>  
> [Med] Not having an overview to describe the overall structure and help 
> readers navigate among all the various levels is a bug of these specs, IMO. 
> The narrative part of the spec is supposed to help readers digest the 
> structure and zoom in/out when diving into specifics. I think that we need 
> collectively to better explain the rationale of a module design and 
> articulating the various parts of a module. The use of subtrees for too long 
> trees is a means to help structure the description sections.
>  
> RFC8348 is an example of YANG tree pieces which I am using very rarely. In 
> most of the cases, I refer to the YANG catalog to get the complete tree
> [Med] ACK.
>  
> I am wondering whether the issue of YANG tree too-long could be resolved by 
> updating the IETF tooling. For example, I have noted that the html-ized 
> version of the I-Ds is now working well wit

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-05 Thread Italo Busi
I like the idea of relying on tooling with hyperlinks

For txt and pdf, I agree that a link is the best option since these formats are 
not optimized for including YANG trees

Italo

From: Kent Watsen 
Sent: martedì 5 marzo 2024 16:02
To: mohamed.boucad...@orange.com
Cc: Italo Busi ; Qin Wu ; Mahesh 
Jethanandani ; netmod@ietf.org
Subject: Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis


It seems that there are two camps:

1) those that want the tree-diagrams to be as DRY as possible
2) those that want the tree-diagrams to be as WET as possible


  DRY = Don't Repeat Yourself
  WET = Write Every Time

Tooling can help both cases.

For (1), the tree-diagrams are unexpanded, but surrounding text should point to 
where each used-grouping is defined.   The better tooling-assisted approach, is 
for the used groupings *inside the tree-diagram” to become hyperlinks (only 
possible in supporting formats).   Extending this idea further, hyperlinks 
could be provided for typedefs and identities too.

For (2), for plain-text and PDF formats, a link to where the image can be 
accessed would be nice.  For the HTML format, inlining the complete (unfolded) 
tree-diagram with horizontal-scrolling would be ideal.

Kent



On Mar 5, 2024, at 3:01 AM, 
mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com> wrote:

Hi Italo,

Thanks for sharing your thoughts.

Please see inline.

Cheers,
Med

De : Italo Busi mailto:italo.b...@huawei.com>>
Envoyé : lundi 4 mars 2024 19:38
À : Qin Wu mailto:bill...@huawei.com>>; Mahesh Jethanandani 
mailto:mjethanand...@gmail.com>>; BOUCADAIR Mohamed 
INNOV/NET mailto:mohamed.boucad...@orange.com>>
Cc : netmod@ietf.org<mailto:netmod@ietf.org>
Objet : RE: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

Hi Med,

In my personal experience, I have found the YANG tree included in the IETF 
RFCs/I-Ds useful only when they are complete, even if they are too long
[Med] I agree that having readily available full trees is useful, however the 
question is whether it should be embedded in the RFC text or would having 
stable links to access such trees be much more convenient? Note also that when 
the tree is too long, there are better places to display them for better user 
experience (control views, etc.), which we don’t have with the txt version.

In RFC8795 you can find an example of a too-long YANG tree which I am using 
quite often

[Med] If the Datatracker includes a link to the tree or 8795 includes a stable 
pointer to the full tree without the editing limitations of IETF docs, the 
experience would be the same, if not better. No?


I have found YANG trees with unexpanded grouping almost impossible to use. In 
draft-ietf-teas-yang-te you can find an example of a YANG tree with unexpanded 
grouping which I am not using at all. In this case, I refer to the YANG catalog 
to get the complete tree

[Med] ACK.

I have also found the YANG tree pieces almost useless (even if much better than 
the YANG trees with unexpanded grouping) without some overview.

[Med] Not having an overview to describe the overall structure and help readers 
navigate among all the various levels is a bug of these specs, IMO. The 
narrative part of the spec is supposed to help readers digest the structure and 
zoom in/out when diving into specifics. I think that we need collectively to 
better explain the rationale of a module design and articulating the various 
parts of a module. The use of subtrees for too long trees is a means to help 
structure the description sections.

RFC8348 is an example of YANG tree pieces which I am using very rarely. In most 
of the cases, I refer to the YANG catalog to get the complete tree
[Med] ACK.

I am wondering whether the issue of YANG tree too-long could be resolved by 
updating the IETF tooling. For example, I have noted that the html-ized version 
of the I-Ds is now working well with artwork exceeding the 72 characters limit …

Maybe the html or html-ized version of the I-D/RFC might include the jstree 
pyang output instead of the tree pyang output

[Med] Fully agree that tooling is the way to go here. Having a stable pointer 
to the tree (including displaying it from the Datatracker metadata) would 
achieve that objective.

Back to the txt version, here is an updated version of the reco (for further 
discussion):

==
NEW:
   YANG tree diagrams provide a concise representation of a YANG module
   and SHOULD be included to help readers understand YANG module
   structure.  If the complete tree diagram for a module becomes long
   (more than 2 pages, typically), the diagram SHOULD be split into
   several smaller diagrams (a.k.a subtrees).  For the reader's
   convenience, a subtree should fit within a page.  If the complete
   tree diagram is too long (more than 5 pages, typically) even with
   groupings unexpanded (Section 2

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-05 Thread Kent Watsen

It seems that there are two camps:

1) those that want the tree-diagrams to be as DRY as possible
2) those that want the tree-diagrams to be as WET as possible

DRY = Don't Repeat Yourself
WET = Write Every Time

Tooling can help both cases.

For (1), the tree-diagrams are unexpanded, but surrounding text should point to 
where each used-grouping is defined.   The better tooling-assisted approach, is 
for the used groupings *inside the tree-diagram” to become hyperlinks (only 
possible in supporting formats).   Extending this idea further, hyperlinks 
could be provided for typedefs and identities too.

For (2), for plain-text and PDF formats, a link to where the image can be 
accessed would be nice.  For the HTML format, inlining the complete (unfolded) 
tree-diagram with horizontal-scrolling would be ideal.

Kent


> On Mar 5, 2024, at 3:01 AM, mohamed.boucad...@orange.com wrote:
> 
> Hi Italo,
>  
> Thanks for sharing your thoughts.
>  
> Please see inline.
>  
> Cheers,
> Med
>  
> De : Italo Busi mailto:italo.b...@huawei.com>>
> Envoyé : lundi 4 mars 2024 19:38
> À : Qin Wu mailto:bill...@huawei.com>>; Mahesh 
> Jethanandani mailto:mjethanand...@gmail.com>>; 
> BOUCADAIR Mohamed INNOV/NET  <mailto:mohamed.boucad...@orange.com>>
> Cc : netmod@ietf.org <mailto:netmod@ietf.org>
> Objet : RE: [netmod] Long trees RE: Next steps for 
> draft-ietf-netmod-rfc8407bis
>  
> Hi Med,
>  
> In my personal experience, I have found the YANG tree included in the IETF 
> RFCs/I-Ds useful only when they are complete, even if they are too long
> [Med] I agree that having readily available full trees is useful, however the 
> question is whether it should be embedded in the RFC text or would having 
> stable links to access such trees be much more convenient? Note also that 
> when the tree is too long, there are better places to display them for better 
> user experience (control views, etc.), which we don’t have with the txt 
> version.
>  
> In RFC8795 you can find an example of a too-long YANG tree which I am using 
> quite often
>  
> [Med] If the Datatracker includes a link to the tree or 8795 includes a 
> stable pointer to the full tree without the editing limitations of IETF docs, 
> the experience would be the same, if not better. No?
>  
>  
> I have found YANG trees with unexpanded grouping almost impossible to use. In 
> draft-ietf-teas-yang-te you can find an example of a YANG tree with 
> unexpanded grouping which I am not using at all. In this case, I refer to the 
> YANG catalog to get the complete tree
>  
> [Med] ACK.
>  
> I have also found the YANG tree pieces almost useless (even if much better 
> than the YANG trees with unexpanded grouping) without some overview.
>  
> [Med] Not having an overview to describe the overall structure and help 
> readers navigate among all the various levels is a bug of these specs, IMO. 
> The narrative part of the spec is supposed to help readers digest the 
> structure and zoom in/out when diving into specifics. I think that we need 
> collectively to better explain the rationale of a module design and 
> articulating the various parts of a module. The use of subtrees for too long 
> trees is a means to help structure the description sections.
>  
> RFC8348 is an example of YANG tree pieces which I am using very rarely. In 
> most of the cases, I refer to the YANG catalog to get the complete tree
> [Med] ACK.
>  
> I am wondering whether the issue of YANG tree too-long could be resolved by 
> updating the IETF tooling. For example, I have noted that the html-ized 
> version of the I-Ds is now working well with artwork exceeding the 72 
> characters limit …
>  
> Maybe the html or html-ized version of the I-D/RFC might include the jstree 
> pyang output instead of the tree pyang output
>  
> [Med] Fully agree that tooling is the way to go here. Having a stable pointer 
> to the tree (including displaying it from the Datatracker metadata) would 
> achieve that objective.
>  
> Back to the txt version, here is an updated version of the reco (for further 
> discussion):
>  
> ==
> NEW:
>YANG tree diagrams provide a concise representation of a YANG module
>and SHOULD be included to help readers understand YANG module
>structure.  If the complete tree diagram for a module becomes long
>(more than 2 pages, typically), the diagram SHOULD be split into
>several smaller diagrams (a.k.a subtrees).  For the reader's
>convenience, a subtree should fit within a page.  If the complete
>tree diagram is too long (more than 5 pages, typically) even with
>groupings unexpanded (Section 2.2 of [RFC8340]), the authors SHO

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-05 Thread mohamed . boucadair
Hi Italo,

Thanks for sharing your thoughts.

Please see inline.

Cheers,
Med

De : Italo Busi 
Envoyé : lundi 4 mars 2024 19:38
À : Qin Wu ; Mahesh Jethanandani ; 
BOUCADAIR Mohamed INNOV/NET 
Cc : netmod@ietf.org
Objet : RE: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

Hi Med,

In my personal experience, I have found the YANG tree included in the IETF 
RFCs/I-Ds useful only when they are complete, even if they are too long
[Med] I agree that having readily available full trees is useful, however the 
question is whether it should be embedded in the RFC text or would having 
stable links to access such trees be much more convenient? Note also that when 
the tree is too long, there are better places to display them for better user 
experience (control views, etc.), which we don’t have with the txt version.

In RFC8795 you can find an example of a too-long YANG tree which I am using 
quite often

[Med] If the Datatracker includes a link to the tree or 8795 includes a stable 
pointer to the full tree without the editing limitations of IETF docs, the 
experience would be the same, if not better. No?


I have found YANG trees with unexpanded grouping almost impossible to use. In 
draft-ietf-teas-yang-te you can find an example of a YANG tree with unexpanded 
grouping which I am not using at all. In this case, I refer to the YANG catalog 
to get the complete tree

[Med] ACK.

I have also found the YANG tree pieces almost useless (even if much better than 
the YANG trees with unexpanded grouping) without some overview.

[Med] Not having an overview to describe the overall structure and help readers 
navigate among all the various levels is a bug of these specs, IMO. The 
narrative part of the spec is supposed to help readers digest the structure and 
zoom in/out when diving into specifics. I think that we need collectively to 
better explain the rationale of a module design and articulating the various 
parts of a module. The use of subtrees for too long trees is a means to help 
structure the description sections.

RFC8348 is an example of YANG tree pieces which I am using very rarely. In most 
of the cases, I refer to the YANG catalog to get the complete tree
[Med] ACK.

I am wondering whether the issue of YANG tree too-long could be resolved by 
updating the IETF tooling. For example, I have noted that the html-ized version 
of the I-Ds is now working well with artwork exceeding the 72 characters limit …

Maybe the html or html-ized version of the I-D/RFC might include the jstree 
pyang output instead of the tree pyang output

[Med] Fully agree that tooling is the way to go here. Having a stable pointer 
to the tree (including displaying it from the Datatracker metadata) would 
achieve that objective.

Back to the txt version, here is an updated version of the reco (for further 
discussion):

==
NEW:
   YANG tree diagrams provide a concise representation of a YANG module
   and SHOULD be included to help readers understand YANG module
   structure.  If the complete tree diagram for a module becomes long
   (more than 2 pages, typically), the diagram SHOULD be split into
   several smaller diagrams (a.k.a subtrees).  For the reader's
   convenience, a subtree should fit within a page.  If the complete
   tree diagram is too long (more than 5 pages, typically) even with
   groupings unexpanded (Section 2.2 of [RFC8340]), the authors SHOULD
   NOT include it in the document.  A stable pointer to retrieve the
   full tree MAY be included.

   The document SHOULD include the following note if the full tree is
   not included:

  -- If no stable pointer to retrieve the tree is included

  The full tree diagram of the module can be generated using,
  e.g., the "pyang" tool. That tree is not included here because
  it is too long (Section 3.4 of [RFC]). Instead, subtrees
  are provided for the reader's convenience.

  -- If a stable pointer to retrieve the tree is included

  The full tree diagram of the module can be retrieved at
  . That tree is not included here because it is too
  long (Section 3.4 of [RFC]). Instead, subtrees are provided
  for the reader's convenience.

   These guidelines take precedence over the generic guidance in
   Section 3 of [RFC8340].
==

My 2 cents

Italo

From: Qin Wu mailto:bill...@huawei.com>>
Sent: giovedì 29 febbraio 2024 02:51
To: Mahesh Jethanandani 
mailto:mjethanand...@gmail.com>>; 
mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com>
Cc: netmod@ietf.org<mailto:netmod@ietf.org>
Subject: Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

+1,  a few thoughts to share.

I know this is tricky question related to tooling or artifact generation and 
representation.
I am wondering whether we can make YANG tree diagram in a "collapsed" state 
where all the Leaf nodes and only leaf nodes are hidden from view until its 
parent nod

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-04 Thread Kent Watsen
Hi Italo,

> On Mar 4, 2024, at 1:38 PM, Italo Busi 
>  wrote:
> 
> I am wondering whether the issue of YANG tree too-long could be resolved by 
> updating the IETF tooling. For example, I have noted that the html-ized 
> version of the I-Ds is now working well with artwork exceeding the 72 
> characters limit …
>  
> Maybe the html or html-ized version of the I-D/RFC might include the jstree 
> pyang output instead of the tree pyang output

This is what I’ve been saying for awhile now.

Datatracker should unfold folded-artwork for formats like HTML that can provide 
horizontal scrollbars.

That said, the desire to break tree-diagrams into pieces won’t be resolved, as 
authors still need to support plain-text output…  grrr


Personally, I prefer whole-trees (if not folded), which are much easier to 
place into a document, but many in the WG push for tree-diagram snippets.   
Hope we can reach a consensus on this…

K


___
netmod mailing list
netmod@ietf.org
https://www.ietf.org/mailman/listinfo/netmod


Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-04 Thread Italo Busi
Hi Med,

In my personal experience, I have found the YANG tree included in the IETF 
RFCs/I-Ds useful only when they are complete, even if they are too long

In RFC8795 you can find an example of a too-long YANG tree which I am using 
quite often

I have found YANG trees with unexpanded grouping almost impossible to use. In 
draft-ietf-teas-yang-te you can find an example of a YANG tree with unexpanded 
grouping which I am not using at all. In this case, I refer to the YANG catalog 
to get the complete tree

I have also found the YANG tree pieces almost useless (even if much better than 
the YANG trees with unexpanded grouping) without some overview. RFC8348 is an 
example of YANG tree pieces which I am using very rarely. In most of the cases, 
I refer to the YANG catalog to get the complete tree

I am wondering whether the issue of YANG tree too-long could be resolved by 
updating the IETF tooling. For example, I have noted that the html-ized version 
of the I-Ds is now working well with artwork exceeding the 72 characters limit …

Maybe the html or html-ized version of the I-D/RFC might include the jstree 
pyang output instead of the tree pyang output

My 2 cents

Italo

From: Qin Wu 
Sent: giovedì 29 febbraio 2024 02:51
To: Mahesh Jethanandani ; mohamed.boucad...@orange.com
Cc: netmod@ietf.org
Subject: Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

+1,  a few thoughts to share.

I know this is tricky question related to tooling or artifact generation and 
representation.
I am wondering whether we can make YANG tree diagram in a "collapsed" state 
where all the Leaf nodes and only leaf nodes are hidden from view until its 
parent node is expanded, which can improve readability of the tree diagram,
In many cases can greatly reduce the size of YANG tree diagram, make it fit 
into one page.

Moving compete tree diagram or artifacts is another option we can pursue. Also 
generating YANG tree along with YANG file in 
https://github.com/YangModels/yang/tree/main/standard/ietf
Is another option we can take a look at.

-Qin
发件人: netmod [mailto:netmod-boun...@ietf.org] 代表 Mahesh Jethanandani
发送时间: 2024年2月29日 7:02
收件人: mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com>
抄送: netmod@ietf.org<mailto:netmod@ietf.org>
主题: Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

I would agree with Andy that it is not clear how long is “too long”.

BGP YANG model, which is perhaps one of the biggest models at 150 pages long, 
has multiple tree diagrams none of which are more than one page long.

If the complete tree diagram is too long, could it moved to the Appendix, 
instead of banishing it from the document completely? Sorry Jan, but I hope no 
one is cutting down trees to read the entire tree diagram. Sometimes, albeit 
rarely, it is helpful to have the complete tree diagram handy to reference 
where a particular node is in the tree.

Cheers.

On Feb 28, 2024, at 8:29 AM, 
mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com> wrote:

Hi Jan,

Thanks for the comments.

Here is a first attempt to address the long trees point while taking into 
account expanded/unexpanded uses:

NEW:
   YANG tree diagrams provide a concise representation of a YANG module
   and SHOULD be included to help readers understand YANG module
   structure.  If the complete tree diagram for a module becomes too
   long, the diagram SHOULD be split into several smaller diagrams.  If
   the complete tree diagram is too long even with groupings unexpanded
   (Section 2.2 of [RFC8340]), authors SHOULD NOT include it in the
   document.

   These guidelines take precedence over the generic guidance in
   Section 3 of [RFC8340].

For convenience a diff for the proposed change can be 
seenhttps://author-tools.ietf.org/api/iddiff?url_1=https://boucadair.github.io/rfc8407bis/draft-ietf-netmod-rfc8407bis.txt_2=https://boucadair.github.io/rfc8407bis/long-trees/draft-ietf-netmod-rfc8407bis.txt

Cheers,
Med

De : Jan Lindblad mailto:j...@tail-f.com>>
Envoyé : mercredi 28 février 2024 15:21
À : BOUCADAIR Mohamed INNOV/NET 
mailto:mohamed.boucad...@orange.com>>
Cc : netmod@ietf.org<mailto:netmod@ietf.org>
Objet : Re: [netmod] Next steps for draft-ietf-netmod-rfc8407bis

Med, author team,

Thank you for taking the time to get this work done, and well done! This is one 
of those fundamental bricks that saves time and improves quality for the entire 
YANG community.

I read the -09 version and like what I see. I have a couple of minor 
suggestions you might consider.

+ In section 3.4 about tree diagrams, the section text is already advocating 
intermixing smaller tree snippets with explanations (which is great), but I 
wish we could say that
tree diagrams of entire modules SHOULD NOT be included. Just a waste of forest 
and attention span, imho.

+ In section 4.2 about choice of prefixes, it is said that "Prefix values 
SHOULD be short but ar

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-03-03 Thread mohamed . boucadair
Hi Andy, all,

I updated the text to indicate that


  *   “Long” = exceeds 2 pages typically,
  *   “Too long” = exceeds 5 pages
  *   Short subtree: fits within a page

Cheers,
Med

De : Andy Bierman 
Envoyé : mercredi 28 février 2024 19:26
À : BOUCADAIR Mohamed INNOV/NET 
Cc : Jan Lindblad ; netmod@ietf.org
Objet : Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis



On Wed, Feb 28, 2024 at 8:31 AM 
mailto:mohamed.boucad...@orange.com>> wrote:
Hi Jan,

Thanks for the comments.

Here is a first attempt to address the long trees point while taking into 
account expanded/unexpanded uses:

NEW:
   YANG tree diagrams provide a concise representation of a YANG module
   and SHOULD be included to help readers understand YANG module
   structure.  If the complete tree diagram for a module becomes too
   long, the diagram SHOULD be split into several smaller diagrams.  If
   the complete tree diagram is too long even with groupings unexpanded
   (Section 2.2 of [RFC8340]), authors SHOULD NOT include it in the
   document.

   These guidelines take precedence over the generic guidance in
   Section 3 of [RFC8340].



There may not be a natural split for multiple sections.
It is not always clear what to do to implement this guideline.

What is 'too long'? 1 page? 3 pages? 30 pages?

I agree that the guideline needs to be updated to match the current style.


Andy



For convenience a diff for the proposed change can be seen 
https://author-tools.ietf.org/api/iddiff?url_1=https://boucadair.github.io/rfc8407bis/draft-ietf-netmod-rfc8407bis.txt_2=https://boucadair.github.io/rfc8407bis/long-trees/draft-ietf-netmod-rfc8407bis.txt

Cheers,
Med

De : Jan Lindblad mailto:j...@tail-f.com>>
Envoyé : mercredi 28 février 2024 15:21
À : BOUCADAIR Mohamed INNOV/NET 
mailto:mohamed.boucad...@orange.com>>
Cc : netmod@ietf.org<mailto:netmod@ietf.org>
Objet : Re: [netmod] Next steps for draft-ietf-netmod-rfc8407bis

Med, author team,

Thank you for taking the time to get this work done, and well done! This is one 
of those fundamental bricks that saves time and improves quality for the entire 
YANG community.

I read the -09 version and like what I see. I have a couple of minor 
suggestions you might consider.

+ In section 3.4 about tree diagrams, the section text is already advocating 
intermixing smaller tree snippets with explanations (which is great), but I 
wish we could say that
tree diagrams of entire modules SHOULD NOT be included. Just a waste of forest 
and attention span, imho.

+ In section 4.2 about choice of prefixes, it is said that "Prefix values 
SHOULD be short but are also likely to be unique." I used to say the same 
thing. In recent years, however, I have started to stress the importance of 
uniqueness much more. I'd say something like "Prefix values SHOULD be selected 
carefully to be unique, and ideally not too long." The reason for my change is 
I have met several engineers who have been deeply confused (to the point of 
costing real money) when the same prefix has shown up in multiple places. It's 
just an unnecessary part of the learning curve associated with YANG.

In fact, I have started to recommend people to set the prefix to equal the 
module name. This also solves another problem, which is that the "prefixes" you 
see in RESTCONF are module names, and the confusion of what to use where is 
sometimes suffocating. I understand if many think I'm going overboard here, but 
when we pretend that modules don't have prefixes, only module names, there is a 
lot less friction in learning the ropes.

+ In section 4.6.2 regarding useless (in YANG Context) functions in the XPath 
function library, it is said that the "YANG compiler" should return false, etc. 
Better wording might be that the XPath execution environment (or something) 
should return false, etc. The YANG compiler is not even running when the calls 
to those functions are happening.

+ In section 4.11.5 regarding booleans, it is said that booleans can take 
values true and false. This is true in mathematics :-) but in YANG a boolean 
leaf can additionally take the "value" of "not set". Actually, "not set" is a 
possibility for leafs in general, unless it is declared mandatory true, or has 
a default. In my experience, one of the most common YANG modeling issues is 
when people model a leaf foo, which isn't mandatory, has no default and the 
description statement does not say what happens if the leaf is not set. In many 
cases, there is a sort of natural meaning, but with booleans leafs in 
particular, the absence of the leaf is typically highly ambiguous. I think this 
hole merits a recommendation clause in the I-D.

Best Regards,
/jan



On 28 Feb 2024, at 10:51, 
mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com> wrote:

Hi all,

I think that this version is ready for the WGLC.

The document fully cove

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-02-28 Thread Qin Wu
+1,  a few thoughts to share.

I know this is tricky question related to tooling or artifact generation and 
representation.
I am wondering whether we can make YANG tree diagram in a "collapsed" state 
where all the Leaf nodes and only leaf nodes are hidden from view until its 
parent node is expanded, which can improve readability of the tree diagram,
In many cases can greatly reduce the size of YANG tree diagram, make it fit 
into one page.

Moving compete tree diagram or artifacts is another option we can pursue. Also 
generating YANG tree along with YANG file in 
https://github.com/YangModels/yang/tree/main/standard/ietf
Is another option we can take a look at.

-Qin
发件人: netmod [mailto:netmod-boun...@ietf.org] 代表 Mahesh Jethanandani
发送时间: 2024年2月29日 7:02
收件人: mohamed.boucad...@orange.com
抄送: netmod@ietf.org
主题: Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

I would agree with Andy that it is not clear how long is “too long”.

BGP YANG model, which is perhaps one of the biggest models at 150 pages long, 
has multiple tree diagrams none of which are more than one page long.

If the complete tree diagram is too long, could it moved to the Appendix, 
instead of banishing it from the document completely? Sorry Jan, but I hope no 
one is cutting down trees to read the entire tree diagram. Sometimes, albeit 
rarely, it is helpful to have the complete tree diagram handy to reference 
where a particular node is in the tree.

Cheers.


On Feb 28, 2024, at 8:29 AM, 
mohamed.boucad...@orange.com<mailto:mohamed.boucad...@orange.com> wrote:

Hi Jan,

Thanks for the comments.

Here is a first attempt to address the long trees point while taking into 
account expanded/unexpanded uses:

NEW:
   YANG tree diagrams provide a concise representation of a YANG module
   and SHOULD be included to help readers understand YANG module
   structure.  If the complete tree diagram for a module becomes too
   long, the diagram SHOULD be split into several smaller diagrams.  If
   the complete tree diagram is too long even with groupings unexpanded
   (Section 2.2 of [RFC8340]), authors SHOULD NOT include it in the
   document.

   These guidelines take precedence over the generic guidance in
   Section 3 of [RFC8340].

For convenience a diff for the proposed change can be 
seenhttps://author-tools.ietf.org/api/iddiff?url_1=https://boucadair.github.io/rfc8407bis/draft-ietf-netmod-rfc8407bis.txt_2=https://boucadair.github.io/rfc8407bis/long-trees/draft-ietf-netmod-rfc8407bis.txt

Cheers,
Med

De : Jan Lindblad mailto:j...@tail-f.com>>
Envoyé : mercredi 28 février 2024 15:21
À : BOUCADAIR Mohamed INNOV/NET 
mailto:mohamed.boucad...@orange.com>>
Cc : netmod@ietf.org<mailto:netmod@ietf.org>
Objet : Re: [netmod] Next steps for draft-ietf-netmod-rfc8407bis

Med, author team,

Thank you for taking the time to get this work done, and well done! This is one 
of those fundamental bricks that saves time and improves quality for the entire 
YANG community.

I read the -09 version and like what I see. I have a couple of minor 
suggestions you might consider.

+ In section 3.4 about tree diagrams, the section text is already advocating 
intermixing smaller tree snippets with explanations (which is great), but I 
wish we could say that
tree diagrams of entire modules SHOULD NOT be included. Just a waste of forest 
and attention span, imho.

+ In section 4.2 about choice of prefixes, it is said that "Prefix values 
SHOULD be short but are also likely to be unique." I used to say the same 
thing. In recent years, however, I have started to stress the importance of 
uniqueness much more. I'd say something like "Prefix values SHOULD be selected 
carefully to be unique, and ideally not too long." The reason for my change is 
I have met several engineers who have been deeply confused (to the point of 
costing real money) when the same prefix has shown up in multiple places. It's 
just an unnecessary part of the learning curve associated with YANG.

In fact, I have started to recommend people to set the prefix to equal the 
module name. This also solves another problem, which is that the "prefixes" you 
see in RESTCONF are module names, and the confusion of what to use where is 
sometimes suffocating. I understand if many think I'm going overboard here, but 
when we pretend that modules don't have prefixes, only module names, there is a 
lot less friction in learning the ropes.

+ In section 4.6.2 regarding useless (in YANG Context) functions in the XPath 
function library, it is said that the "YANG compiler" should return false, etc. 
Better wording might be that the XPath execution environment (or something) 
should return false, etc. The YANG compiler is not even running when the calls 
to those functions are happening.

+ In section 4.11.5 regarding booleans, it is said that booleans can take 
values true and false. This is true in mathematics :-)

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-02-28 Thread Mahesh Jethanandani
I would agree with Andy that it is not clear how long is “too long”. 

BGP YANG model, which is perhaps one of the biggest models at 150 pages long, 
has multiple tree diagrams none of which are more than one page long.

If the complete tree diagram is too long, could it moved to the Appendix, 
instead of banishing it from the document completely? Sorry Jan, but I hope no 
one is cutting down trees to read the entire tree diagram. Sometimes, albeit 
rarely, it is helpful to have the complete tree diagram handy to reference 
where a particular node is in the tree.

Cheers.

> On Feb 28, 2024, at 8:29 AM, mohamed.boucad...@orange.com wrote:
> 
> Hi Jan,
>  
> Thanks for the comments.
>  
> Here is a first attempt to address the long trees point while taking into 
> account expanded/unexpanded uses:
>  
> NEW:
>YANG tree diagrams provide a concise representation of a YANG module
>and SHOULD be included to help readers understand YANG module
>structure.  If the complete tree diagram for a module becomes too
>long, the diagram SHOULD be split into several smaller diagrams.  If
>the complete tree diagram is too long even with groupings unexpanded
>(Section 2.2 of [RFC8340]), authors SHOULD NOT include it in the
>document.
>  
>These guidelines take precedence over the generic guidance in
>Section 3 of [RFC8340].
>  
> For convenience a diff for the proposed change can be 
> seenhttps://author-tools.ietf.org/api/iddiff?url_1=https://boucadair.github.io/rfc8407bis/draft-ietf-netmod-rfc8407bis.txt_2=https://boucadair.github.io/rfc8407bis/long-trees/draft-ietf-netmod-rfc8407bis.txt
>  
> 
>  
> Cheers,
> Med
>  
> De : Jan Lindblad mailto:j...@tail-f.com>> 
> Envoyé : mercredi 28 février 2024 15:21
> À : BOUCADAIR Mohamed INNOV/NET  >
> Cc : netmod@ietf.org 
> Objet : Re: [netmod] Next steps for draft-ietf-netmod-rfc8407bis
>  
> Med, author team,
>  
> Thank you for taking the time to get this work done, and well done! This is 
> one of those fundamental bricks that saves time and improves quality for the 
> entire YANG community.
>  
> I read the -09 version and like what I see. I have a couple of minor 
> suggestions you might consider.
>  
> + In section 3.4 about tree diagrams, the section text is already advocating 
> intermixing smaller tree snippets with explanations (which is great), but I 
> wish we could say that 
> tree diagrams of entire modules SHOULD NOT be included. Just a waste of 
> forest and attention span, imho.
>  
> + In section 4.2 about choice of prefixes, it is said that "Prefix values 
> SHOULD be short but are also likely to be unique." I used to say the same 
> thing. In recent years, however, I have started to stress the importance of 
> uniqueness much more. I'd say something like "Prefix values SHOULD be 
> selected carefully to be unique, and ideally not too long." The reason for my 
> change is I have met several engineers who have been deeply confused (to the 
> point of costing real money) when the same prefix has shown up in multiple 
> places. It's just an unnecessary part of the learning curve associated with 
> YANG.
>  
> In fact, I have started to recommend people to set the prefix to equal the 
> module name. This also solves another problem, which is that the "prefixes" 
> you see in RESTCONF are module names, and the confusion of what to use where 
> is sometimes suffocating. I understand if many think I'm going overboard 
> here, but when we pretend that modules don't have prefixes, only module 
> names, there is a lot less friction in learning the ropes.
>  
> + In section 4.6.2 regarding useless (in YANG Context) functions in the XPath 
> function library, it is said that the "YANG compiler" should return false, 
> etc. Better wording might be that the XPath execution environment (or 
> something) should return false, etc. The YANG compiler is not even running 
> when the calls to those functions are happening.
>  
> + In section 4.11.5 regarding booleans, it is said that booleans can take 
> values true and false. This is true in mathematics :-) but in YANG a boolean 
> leaf can additionally take the "value" of "not set". Actually, "not set" is a 
> possibility for leafs in general, unless it is declared mandatory true, or 
> has a default. In my experience, one of the most common YANG modeling issues 
> is when people model a leaf foo, which isn't mandatory, has no default and 
> the description statement does not say what happens if the leaf is not set. 
> In many cases, there is a sort of natural meaning, but with booleans leafs in 
> particular, the absence of the leaf is typically highly ambiguous. I think 
> this hole merits a recommendation clause in the I-D.
>  

Re: [netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-02-28 Thread Andy Bierman
On Wed, Feb 28, 2024 at 8:31 AM  wrote:

> Hi Jan,
>
>
>
> Thanks for the comments.
>
>
>
> Here is a first attempt to address the long trees point while taking into
> account expanded/unexpanded uses:
>
>
>
> NEW:
>
>YANG tree diagrams provide a concise representation of a YANG module
>
>and SHOULD be included to help readers understand YANG module
>
>structure.  If the complete tree diagram for a module becomes too
>
>long, the diagram SHOULD be split into several smaller diagrams.  If
>
>the complete tree diagram is too long even with groupings unexpanded
>
>(Section 2.2 of [RFC8340]), authors SHOULD NOT include it in the
>
>document.
>
>
>
>These guidelines take precedence over the generic guidance in
>
>Section 3 of [RFC8340].
>
>
>


There may not be a natural split for multiple sections.
It is not always clear what to do to implement this guideline.

What is 'too long'? 1 page? 3 pages? 30 pages?

I agree that the guideline needs to be updated to match the current style.


Andy



For convenience a diff for the proposed change can be seen
> https://author-tools.ietf.org/api/iddiff?url_1=https://boucadair.github.io/rfc8407bis/draft-ietf-netmod-rfc8407bis.txt_2=https://boucadair.github.io/rfc8407bis/long-trees/draft-ietf-netmod-rfc8407bis.txt
>
>
>
> Cheers,
>
> Med
>
>
>
> *De :* Jan Lindblad 
> *Envoyé :* mercredi 28 février 2024 15:21
> *À :* BOUCADAIR Mohamed INNOV/NET 
> *Cc :* netmod@ietf.org
> *Objet :* Re: [netmod] Next steps for draft-ietf-netmod-rfc8407bis
>
>
>
> Med, author team,
>
>
>
> Thank you for taking the time to get this work done, and well done! This
> is one of those fundamental bricks that saves time and improves quality for
> the entire YANG community.
>
>
>
> I read the -09 version and like what I see. I have a couple of minor
> suggestions you might consider.
>
>
>
> + In section 3.4 about tree diagrams, the section text is already
> advocating intermixing smaller tree snippets with explanations (which is
> great), but I wish we could say that
>
> tree diagrams of entire modules SHOULD NOT be included. Just a waste of
> forest and attention span, imho.
>
>
>
> + In section 4.2 about choice of prefixes, it is said that "Prefix values
> SHOULD be short but are also likely to be unique." I used to say the same
> thing. In recent years, however, I have started to stress the importance of
> uniqueness much more. I'd say something like "Prefix values SHOULD be
> selected carefully to be unique, and ideally not too long." The reason for
> my change is I have met several engineers who have been deeply confused (to
> the point of costing real money) when the same prefix has shown up in
> multiple places. It's just an unnecessary part of the learning curve
> associated with YANG.
>
>
>
> In fact, I have started to recommend people to set the prefix to equal the
> module name. This also solves another problem, which is that the "prefixes"
> you see in RESTCONF are module names, and the confusion of what to use
> where is sometimes suffocating. I understand if many think I'm going
> overboard here, but when we pretend that modules don't have prefixes, only
> module names, there is a lot less friction in learning the ropes.
>
>
>
> + In section 4.6.2 regarding useless (in YANG Context) functions in the
> XPath function library, it is said that the "YANG compiler" should return
> false, etc. Better wording might be that the XPath execution environment
> (or something) should return false, etc. The YANG compiler is not even
> running when the calls to those functions are happening.
>
>
>
> + In section 4.11.5 regarding booleans, it is said that booleans can take
> values true and false. This is true in mathematics :-) but in YANG a
> boolean leaf can additionally take the "value" of "not set". Actually, "not
> set" is a possibility for leafs in general, unless it is declared mandatory
> true, or has a default. In my experience, one of the most common YANG
> modeling issues is when people model a leaf foo, which isn't mandatory, has
> no default and the description statement does not say what happens if the
> leaf is not set. In many cases, there is a sort of natural meaning, but
> with booleans leafs in particular, the absence of the leaf is typically
> highly ambiguous. I think this hole merits a recommendation clause in the
> I-D.
>
>
>
> Best Regards,
>
> /jan
>
>
>
>
>
>
>
> On 28 Feb 2024, at 10:51, mohamed.boucad...@orange.com wrote:
>
>
>
> Hi all,
>
> I think that this version is ready for the WGLC.
>
> The document fully covers the items promised when requesting adoption [1].
> As listed in the ACK section, we also solicited and integrated feedback
> from many yangdoctors, solicited SAAG WG to review the security text, etc.
> Refer to 1.1 for a comprehensive list of the changes.
>
> Cheers,
> Med
>
> [1] Slide#7 of
> 

[netmod] Long trees RE: Next steps for draft-ietf-netmod-rfc8407bis

2024-02-28 Thread mohamed . boucadair
Hi Jan,

Thanks for the comments.

Here is a first attempt to address the long trees point while taking into 
account expanded/unexpanded uses:

NEW:
   YANG tree diagrams provide a concise representation of a YANG module
   and SHOULD be included to help readers understand YANG module
   structure.  If the complete tree diagram for a module becomes too
   long, the diagram SHOULD be split into several smaller diagrams.  If
   the complete tree diagram is too long even with groupings unexpanded
   (Section 2.2 of [RFC8340]), authors SHOULD NOT include it in the
   document.

   These guidelines take precedence over the generic guidance in
   Section 3 of [RFC8340].

For convenience a diff for the proposed change can be seen 
https://author-tools.ietf.org/api/iddiff?url_1=https://boucadair.github.io/rfc8407bis/draft-ietf-netmod-rfc8407bis.txt_2=https://boucadair.github.io/rfc8407bis/long-trees/draft-ietf-netmod-rfc8407bis.txt

Cheers,
Med

De : Jan Lindblad 
Envoyé : mercredi 28 février 2024 15:21
À : BOUCADAIR Mohamed INNOV/NET 
Cc : netmod@ietf.org
Objet : Re: [netmod] Next steps for draft-ietf-netmod-rfc8407bis

Med, author team,

Thank you for taking the time to get this work done, and well done! This is one 
of those fundamental bricks that saves time and improves quality for the entire 
YANG community.

I read the -09 version and like what I see. I have a couple of minor 
suggestions you might consider.

+ In section 3.4 about tree diagrams, the section text is already advocating 
intermixing smaller tree snippets with explanations (which is great), but I 
wish we could say that
tree diagrams of entire modules SHOULD NOT be included. Just a waste of forest 
and attention span, imho.

+ In section 4.2 about choice of prefixes, it is said that "Prefix values 
SHOULD be short but are also likely to be unique." I used to say the same 
thing. In recent years, however, I have started to stress the importance of 
uniqueness much more. I'd say something like "Prefix values SHOULD be selected 
carefully to be unique, and ideally not too long." The reason for my change is 
I have met several engineers who have been deeply confused (to the point of 
costing real money) when the same prefix has shown up in multiple places. It's 
just an unnecessary part of the learning curve associated with YANG.

In fact, I have started to recommend people to set the prefix to equal the 
module name. This also solves another problem, which is that the "prefixes" you 
see in RESTCONF are module names, and the confusion of what to use where is 
sometimes suffocating. I understand if many think I'm going overboard here, but 
when we pretend that modules don't have prefixes, only module names, there is a 
lot less friction in learning the ropes.

+ In section 4.6.2 regarding useless (in YANG Context) functions in the XPath 
function library, it is said that the "YANG compiler" should return false, etc. 
Better wording might be that the XPath execution environment (or something) 
should return false, etc. The YANG compiler is not even running when the calls 
to those functions are happening.

+ In section 4.11.5 regarding booleans, it is said that booleans can take 
values true and false. This is true in mathematics :-) but in YANG a boolean 
leaf can additionally take the "value" of "not set". Actually, "not set" is a 
possibility for leafs in general, unless it is declared mandatory true, or has 
a default. In my experience, one of the most common YANG modeling issues is 
when people model a leaf foo, which isn't mandatory, has no default and the 
description statement does not say what happens if the leaf is not set. In many 
cases, there is a sort of natural meaning, but with booleans leafs in 
particular, the absence of the leaf is typically highly ambiguous. I think this 
hole merits a recommendation clause in the I-D.

Best Regards,
/jan




On 28 Feb 2024, at 10:51, 
mohamed.boucad...@orange.com wrote:

Hi all,

I think that this version is ready for the WGLC.

The document fully covers the items promised when requesting adoption [1]. As 
listed in the ACK section, we also solicited and integrated feedback from many 
yangdoctors, solicited SAAG WG to review the security text, etc. Refer to 1.1 
for a comprehensive list of the changes.

Cheers,
Med

[1] Slide#7 of 
https://datatracker.ietf.org/meeting/117/materials/slides-117-netmod-7-guidelines-for-authors-and-reviewers-of-documents-containing-yang-data-models-00


-Message d'origine-
De : I-D-Announce 
mailto:i-d-announce-boun...@ietf.org>> De la 
part de
internet-dra...@ietf.org
Envoyé : mercredi 28 février 2024 10:01
À : i-d-annou...@ietf.org
Cc : netmod@ietf.org
Objet : I-D Action: draft-ietf-netmod-rfc8407bis-09.txt

Internet-Draft draft-ietf-netmod-rfc8407bis-09.txt is now available.
It is a work item of the Network Modeling (NETMOD) WG of