Re: [I2nsf] YANG Doctors Working Group Last Call Review of draft-ietf-i2nsf-capability-data-model-04.txt

"Mr. Jaehoon Paul Jeong" <jaehoon.paul@gmail.com> Wed, 19 June 2019 01:48 UTC

MIME-Version: 1.0
References: <449F9B8C-235F-4E65-9FE3-4D34AB063FC4@cisco.com>
In-Reply-To: <449F9B8C-235F-4E65-9FE3-4D34AB063FC4@cisco.com>
From: "Mr. Jaehoon Paul Jeong" <jaehoon.paul@gmail.com>
Date: Wed, 19 Jun 2019 10:47:22 +0900
Message-ID: <CAPK2DewK=5ZVGcQMJwb+=omT3GKio2eQ69vhRd8OYmLcqrr1+g@mail.gmail.com>
To: "Acee Lindem (acee)" <acee@cisco.com>
Cc: "draft-ietf-i2nsf-capability-data-model@ietf.org" <draft-ietf-i2nsf-capability-data-model@ietf.org>, yang-doctors <yang-doctors-bounces@ietf.org>, "i2nsf-ads@ietf.org" <i2nsf-ads@ietf.org>, "i2nsf@ietf.org" <i2nsf@ietf.org>
Content-Type: multipart/alternative; boundary="00000000000036acde058ba36ba1"
Archived-At: <https://mailarchive.ietf.org/arch/msg/i2nsf/Vy0yQ9NCYVOIf2hRqDCBFfe_Z-w>
Subject: Re: [I2nsf] YANG Doctors Working Group Last Call Review of draft-ietf-i2nsf-capability-data-model-04.txt
Precedence: list

Hi Acee,
Thanks for your valuable and constructive comments.

We authors will reflect your comments on the revision during the WGLC.

Thanks.

Best Regards,
Paul

On Wed, Jun 19, 2019 at 3:54 AM Acee Lindem (acee) <acee@cisco.com> wrote:

> Document: draft-ietf-i2nsf-capability-data-model-04.txt
> Reviewer: Acee Lindem
> Review Date: June 18, 2019
> Review Type: Working Group Last Call
> Intended Status: Standards Track
> Summary: Not ready for publication
>
> Modules: "ietf-i2nsf-capability@2019-03-28.yang"
>
> Tech Summary: The model is logically structured and seems to fulfill its
> intended purpose. The "Overview" section defines the usage, context, and
> usage of the model, i.e., it is limited to the NSF capability registration
> interface. However, the draft/model is very rough and not ready for
> working
> group last call. It seems that it has not gotten adequate review by the
> chairs
> and other members of the I2NSF Working Group.
>
> Major Comments:
>
>  1. The "Security Considerations" in section 8 do not conform to the
>     recommended template in
> https://trac.ietf.org/trac/ops/wiki/yang-security-
>     guidelines>
>
>  2. The document is missing XML or JSON examples.
>
>
> Minor Comments:
>
>  1. Section 3.1 should reference RFC8340 rather than attempting to
>     include tree diagram formatting semantics.
>
>  2. Much of the text is very hard to read and awkwardly worded. There
>     are some instances of sentence fragments. I starting trying to
>     remedy this but found I was rewriting the entire draft and, in
>     many cases, I wasn't sure my edits matched the original intent. See
>     the attached diff with suggested edits.
>
>  3. "iicapa" is a poor choice for default model prefix - I suggest
>     "nsfcap". It is just as concise but actually expands to something
>      meaningful.
>
>  4. Similar to the text in the narrative sections of the draft, the text
> in the
>      YANG model description statements is very awkwardly worded.
>
>  5. What are the references for the ipv4-sameip and ipv4-geoip conditions?
>
>  6. Add reference for egress-action-capa.
>
>  7. RFC 2460 is obsoleted by RFC 8200.
>
>  8. Suggest hyphenation of identifiers ipv4-same-ip, ipv4-geo-ip, and
>     ipv6-ip-opts.
>
>  9. Suggest hyphenation of anti-virus and anti-ddos both in identifiers
>     and in the text.
>
> 10. Suggest providing a definitions for absolute and periodic time.
>
> 11. The References do not include all the RFCs referenced by YANG
>        model reference statements.
>
> Thanks,
> Acee
>
>

-- 
===========================
Mr. Jaehoon (Paul) Jeong, Ph.D.
Associate Professor
Department of Software
Sungkyunkwan University
Office: +82-31-299-4957
Email: jaehoon.paul@gmail.com, pauljeong@skku.edu
Personal Homepage: http://iotlab.skku.edu/people-jaehoon-jeong.php
<http://cpslab.skku.edu/people-jaehoon-jeong.php>

[I2nsf] YANG Doctors Working Group Last Call Revi… Acee Lindem (acee)
Re: [I2nsf] YANG Doctors Working Group Last Call … Mr. Jaehoon Paul Jeong