Hi Lou, > On Apr 7, 2025, at 4:46 AM, Lou Berger <[email protected]> wrote: > > Mehesh, > > On 4/4/2025 11:05 AM, Mahesh Jethanandani wrote: >> I like the idea of having the discussion here in netmod of the terminology, >> where the expertise lies, and then taking it back to IESG when we have final >> guidance. > I agree that the WG is the right place for this discussion. > > Is your intent to send the document back to the WG to get agreement on the > new section, or do you just want the WG to discuss and agree on-list? >
Agree on-list so that Med can update the document. Thanks. > For those that missed it: > > On 4/4/2025 1:28 AM, [email protected] > <mailto:[email protected]> wrote: >> Let's us use this discussion to converge on some clear guidance for every >> one. >> >> Here is a first draft of guidance I suggest we add to 8407bis. This inspires >> from the guidance I shared earlier in this thread: >> >> https://author-tools.ietf.org/api/iddiff?url_1=https://netmod-wg.github.io/rfc8407bis/draft-ietf-netmod-rfc8407bis.txt&url_2=https://netmod-wg.github.io/rfc8407bis/model-vs-module/draft-ietf-netmod-rfc8407bis.txt > Which proposes a new section: > > >> 2.5. YANG Data Model vs. YANG Module >> >> Both [RFC6020] and [RFC7950] make a distinction between the following >> concepts: >> >> YANG data model: Describes how data is represented and accessed. >> >> YANG structures data models into modules for ease of use >> [RFC8309]. >> >> YANG module: Defines hierarchies of schema nodes to make a self- >> contained and compilable block of YANG definitions and inclusions. >> >> Is typically a ".yang" file. >> >> A YANG data model can consist (1) of a single YANG module (e.g., >> [RFC9129]) or (2) multiple YANG modules and YANG submodules (e.g., >> [RFC7407]). >> >> Note that the term "YANG model" is sometimes used as an abbreviation >> of YANG data model. However, that term should be avoided in favor of >> YANG data model. Likewise, "YANG data module" should be avoided. >> >> Even if a YANG data model is structured as a single YANG module, YANG >> data model term should be used in the title, abstract, and when the >> overall design is described. "YANG module" should be used when a >> specific "*.yang" file is quoted. > > As contributor, I agree/like where this proposed text is heading. I think it > would be helpful to add some more guidance to authors and reviewers on which > term to use/expect. For example, state that when using terminology related > to YANG module specifications, e.g., augmentation or deviation, a "module" > should be referenced, and that when extending the concepts embodied in a > module this is an extension to the "YANG Model". > > also some nits: > > s/when/in the body of the document where/ > > s/quoted/referenced > > Thanks, > > Lou > > > > Mahesh Jethanandani [email protected]
_______________________________________________ netmod mailing list -- [email protected] To unsubscribe send an email to [email protected]
