# Document Shepherd Write-Up for Group Documents
*This version is dated 4 July 2022.*
Thank you for your service as a document shepherd. Among the responsibilities is
answering the questions in this write-up to give helpful context to Last Call
and Internet Engineering Steering Group ([IESG][1]) reviewers, and your
diligence in completing it is appreciated. The full role of the shepherd is
further described in [RFC 4858][2]. You will need the cooperation of the authors
and editors to complete these checks.
Note that some numbered items contain multiple related questions; please be sure
to answer all of them.
## Document History
1. Does the working group (WG) consensus represent the strong concurrence of a
few individuals, with others being silent, or did it reach broad agreement?
Shepherd:
The document has only one author actively involved in the progression of the
document. But this document has been progressed for more than 6 years and has
been reviewed multiple times during their life time with 2 rounds of WGLC. That
said, the shepherd thinks that this document has reached a broad agreement as
this WG would be expected to reach.
2. Was there controversy about particular points, or were there decisions where
the consensus was particularly rough?
Shepherd:
There was no controversy about particular points, and the shepherd doesn't
notice any decisions where the consensus was particularly rough.
This document has received enough review in both WG meeting and on the NETCONF
WG mailing list, the authors and shepherd believe that all the comments and
questions from that review have be incorporated into the document.
3. Has anyone threatened an appeal or otherwise indicated extreme discontent? If
so, please summarize the areas of conflict in separate email messages to the
responsible Area Director. (It should be in a separate email because this
questionnaire is publicly available.)
Shepherd：
No one threatened an appeal or otherwise indicated extreme discontent.
4. For protocol documents, are there existing implementations of the contents of
the document? Have a significant number of potential implementers indicated
plans to implement? Are any existing implementations reported somewhere,
either in the document itself (as [RFC 7942][3] recommends) or elsewhere
(where)?
Shepherd:
The shepherd knows neither existing nor potential implementations of YANG
models defined in this document. No existing implementations have been publicly
reported.
But client-server suites of documents have always been urged to move forward
and the shepherd notices that this document is referenced by RFC
8783(https://datatracker.ietf.org/doc/rfc8783/) that could use YANG modules
defined in this document for RESTCONF connection management between the DOTS
client and server, both of which are very likely to lead to implementation.
## Additional Reviews
5. Do the contents of this document closely interact with technologies in other
IETF working groups or external organizations, and would it therefore benefit
from their review? Have those reviews occurred? If yes, describe which
reviews took place.
Shepherd:
The shepherd doesn’t think the contents of this document closely interact with
technologies in other IEF working groups or external organizations, and
therefore the shepherd doesn’t believe this document needs review from other
IETF working groups or external organizations. The shepherd doesn't see any
public review from other IETF working groups or external organizations occurred
before.
6. Describe how the document meets any required formal expert review criteria,
such as the MIB Doctor, YANG Doctor, media type, and URI type reviews.
Shepherd:
This document defines two YANG modules. It went through a YANG doctors last
call review by Andy Bierman, and here is a direct link to that review:
https://datatracker.ietf.org/doc/review-ietf-netconf-restconf-client-server-04-yangdoctors-lc-bierman-2017-07-28/
And here is the related discussion about the Yang doctor last call review on
the NETCONF WG mailing list:
https://mailarchive.ietf.org/arch/msg/netconf/AqFxL5A8lvLQYKzNv_ssi_y0THU/
7. If the document contains a YANG module, has the final version of the module
been checked with any of the [recommended validation tools][4] for syntax and
formatting validation? If there are any resulting errors or warnings, what is
the justification for not fixing them at this time? Does the YANG module
comply with the Network Management Datastore Architecture (NMDA) as specified
in [RFC 8342][5]?
Shepherd:
Yes, the document contains two YANG modules. Both have passed through `pyang`
and `yanglint` validation, no errors or warnings have been flagged out.
DataTracker’s YANG validator also reports 0 errors and 0 warnings.
The shepherd has used the following command to check both YANG modules with no
output: $ pyang --ietf ietf-restconf-client@2022-10-19.yang $yanglint
ietf-restconf-client@2022-10-19.yang
$pyang --ietf ietf-restconf-server@2022-10-19.yang
$yanglint ietf-restconf-server@2022-10-19.yang
The shepherd also tested the formatting using the command:
$pyang -f yang --keep-comments --yang-line-length 69
ietf-restconf-client@2022-10-19.yang >test1.yang && diff
ietf-restconf-client@2022-10-19.yang test1.yang
The following results are returned which the shepherd thinks is innocuous:
110c104
< description
---
> description
138d131
<
148,149c141,143
< must 'tls-client-parameters/client-identity
< or http-client-parameters/client-identity';
---
> must
> "tls-client-parameters/client-identity
> or http-client-parameters/client-identity";
254,255c248,250
< must 'tls-client-parameters/client-identity
< or http-client-parameters/client-identity';
---
> must
> "tls-client-parameters/client-identity
> or http-client-parameters/client-identity";
328d322
<
522c516
< if-feature central-restconf-client-supported;
---
> if-feature "central-restconf-client-supported";
528d521
<
$pyang -f yang --keep-comments --yang-line-length 69
ietf-restconf-server@2022-10-19.yang >test2.yang && diff
ietf-restconf-server@2022-10-19.yang test2.yang
The following results are returned which the shepherd thinks is innocuous:
122c114
< description
---
> description
149d140
<
191,195c182,185
< presence
< "Identifies that an external endpoint has been
< configured. This statement is present so the
< mandatory descendant nodes do not imply that
< this node must be configured.";
---
> presence "Identifies that an external endpoint has been
> configured. This statement is present so the
> mandatory descendant nodes do not imply that
> this node must be configured.";
562c549
< if-feature central-restconf-server-supported;
---
> if-feature "central-restconf-server-supported";
568d554
<
Both of the YANG modules defined in this document comply with the Network
Management Datastore Architecture (NMDA) as specified in [RFC 8342].
8. Describe reviews and automated checks performed to validate sections of the
final version of the document written in a formal language, such as XML code,
BNF rules, MIB definitions, CBOR's CDDL, etc.
Shepherd:
The Shepherd has read the document, tested it against "idnits", and validated
the syntactical correctness of both modules defined in the document using
"pyang" and "yanglint", with neither returning any errors or warnings. The
shepherd also checked the XML code in the document using "yanglint" without
returning any errors or warnings.
## Document Shepherd Checks
9. Based on the shepherd's review of the document, is it their opinion that this
document is needed, clearly written, complete, correctly designed, and ready
to be handed off to the responsible Area Director?
Shepherd:
Yes. Based on the shepherd's review of the document, it is the shepherd's
opinion that this document is needed, clearly written, Complete, correctly
designed and ready to be handed off to the responsible Area Director.
10. Several IETF Areas have assembled [lists of common issues that their
reviewers encounter][6]. For which areas have such issues been identified
and addressed? For which does this still need to happen in subsequent
reviews?
Shepherd:
The shepherd took a look at https://trac.ietf.org/trac/iesg/wiki/ExpertTopics
but didn't find any issues that related to this document. There is nothing that
would merit specific attention from subsequent reviews.
11. What type of RFC publication is being requested on the IETF stream ([Best
Current Practice][12], [Proposed Standard, Internet Standard][13],
[Informational, Experimental or Historic][14])? Why is this the proper type
of RFC? Do all Datatracker state attributes correctly reflect this intent?
Shepherd:
The intended RFC status is proposed standard.
This is an appropriate type of RFC for YANG models that will be implemented and
must interoperate. And Datatracker state attributes correctly reflect this
intent (here is the direct link:
https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/).
12. Have reasonable efforts been made to remind all authors of the intellectual
property rights (IPR) disclosure obligations described in [BCP 79][8]? To
the best of your knowledge, have all required disclosures been filed? If
not, explain why. If yes, summarize any relevant discussion, including links
to publicly-available messages when applicable.
Shepherd:
No IPR disclosure has been filed that applies to this document.
The chair has requested an IPR call on the list as part of WGLC process.
The author confirmed that he is unaware of any IPR related to this document.
Thus there is no IPR needs to be disclosed.
Here is the directed link to the IPR call request:
https://mailarchive.ietf.org/arch/msg/netconf/nCeZIQA91_cewM2D0xsHqe5dutY/
13. Has each author, editor, and contributor shown their willingness to be
listed as such? If the total number of authors and editors on the front page
is greater than five, please provide a justification.
Shepherd:
There is only one author listed on the front page who has always been actively
involved in progressing this work without any other editor and contributor.
14. Document any remaining I-D nits in this document. Simply running the [idnits
tool][8] is not enough; please review the ["Content Guidelines" on
authors.ietf.org][15]. (Also note that the current idnits tool generates
some incorrect warnings; a rewrite is underway.)
Shepherd:
I-D nits has been tested against v-27 (here is the direct link:
https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-netconf-restconf-client-server-27.txt),
and it reports 0 error (**), 0 flaws (~~), 10 warnings (==), 0 comment (--),
which are innocuous. Manual check of content guidelines reveals no issues.
15. Should any informative references be normative or vice-versa? See the [IESG
Statement on Normative and Informative References][16].
Shepherd:
The shepherd has checked all the normative and informative references and
thinks that all the references are correctly classified.
16. List any normative references that are not freely available to anyone. Did
the community have sufficient access to review any such normative
references?
Shepherd:
All normative references are freely available to anyone.
17. Are there any normative downward references (see [RFC 3967][9] and [BCP
97][10]) that are not already listed in the [DOWNREF registry][17]? If so,
list them.
Shepherd:
There is no normative downward references.
18. Are there normative references to documents that are not ready to be
submitted to the IESG for publication or are otherwise in an unclear state?
If so, what is the plan for their completion?
Shepherd:
This document has normative references to other client-server and security
suites of documents(I-D.ietf-netconf-http-client-server,
I-D.ietf-netconf-keystore, I-D.ietf-netconf-tcp-client-server,
I-D.ietf-netconf-tls-client-server). It has been planned to submit the set of
drafts to the IESG for publication as a cluster.
19. Will publication of this document change the status of any existing RFCs? If
so, does the Datatracker metadata correctly reflect this and are those RFCs
listed on the title page, in the abstract, and discussed in the
introduction? If not, explain why and point to the part of the document
where the relationship of this document to these other RFCs is discussed.
Shepherd:
No, the publication of this document will not change the status of any existing
RFCs.
20. Describe the document shepherd's review of the IANA considerations section,
especially with regard to its consistency with the body of the document.
Confirm that all aspects of the document requiring IANA assignments are
associated with the appropriate reservations in IANA registries. Confirm
that any referenced IANA registries have been clearly identified. Confirm
that each newly created IANA registry specifies its initial contents,
allocations procedures, and a reasonable name (see [RFC 8126][11]).
Shepherd:
The shepherd has reviewed the IANA consideration section and checked its
consistency with the body of the document. The shepherd confirmed that all
aspects of the document requiring IANA assignments are associated with the
appropriate reservations in IANA registries and any referenced IANA registries
have been clearly identified. There is no newly created IANA registry in this
document.
21. List any new IANA registries that require Designated Expert Review for
future allocations. Are the instructions to the Designated Expert clear?
Please include suggestions of designated experts, if appropriate.
Shepherd:
There is no new IANA registries, thus this document doesn’t require Designated
Expert Review for future allocations.
[1]: https://www.ietf.org/about/groups/iesg/
[2]: https://www.rfc-editor.org/rfc/rfc4858.html
[3]: https://www.rfc-editor.org/rfc/rfc7942.html
[4]: https://trac.ietf.org/trac/ops/wiki/yang-review-tools
[5]: https://www.rfc-editor.org/rfc/rfc8342.html
[6]: https://trac.ietf.org/trac/iesg/wiki/ExpertTopics
[7]: https://www.rfc-editor.org/info/bcp79
[8]: https://www.ietf.org/tools/idnits/
[9]: https://www.rfc-editor.org/rfc/rfc3967.html
[10]: https://www.rfc-editor.org/info/bcp97
[11]: https://www.rfc-editor.org/rfc/rfc8126.html
[12]: https://www.rfc-editor.org/rfc/rfc2026.html#section-5
[13]: https://www.rfc-editor.org/rfc/rfc2026.html#section-4.1
[14]: https://www.rfc-editor.org/rfc/rfc2026.html#section-4.2
[15]: https://authors.ietf.org/en/content-guidelines-overview
[16]:
https://www.ietf.org/about/groups/iesg/statements/normative-informative-references/
[17]: https://datatracker.ietf.org/doc/downref/