Mission & Scope

Mission:

Support Broadband Forum projects, work areas, and activities with the expertise necessary to produce the highest quality YANG specifications possible.

Scope:

• Maintain the Broadband Forum YANG Best Practices documents
• Develop and maintain processes to ensure the consistency, accuracy, and quality of BBF YANG models across all work areas and projects.
• See Review Process described below and at YANG review process

Background

YANG models are being developed in multiple Work Areas, including Access, Provider Cloud, Network Architecture and Connected User. All models published by the Forum should be consistent and adhere to a common set of guidelines.

YANG Doctors

The IETF established a group of volunteers called the "YANG Doctors" which provide the following functions:

• Act as NETCONF/YANG advisors to Working Groups in any area of the IETF
• All YANG documents are passed by a YANG doctor review before being approved by the IESG
• Apply the Guidelines for Authors and Reviewers of YANG Data Model Documents (RFC 8407)

While voluntary, the process to becoming a YANG Doctor requires potential members to submit their qualifications which will be reviewed by the current members who make the final determination for admission.

YANG Ninjas

The YANG Ninjas are a group of volunteers responsible for reviewing YANG data models created within the Broadband Forum, ensuring consistency and adherence to OD-360. This group is overseen by the YANG Sensei.

Membership

Membership criteria mimic what is done for the IETF YANG Doctors, requiring demonstration of an appropriate level of knowledge related to YANG and OD-360. Potential members will submit their qualifications, which will then be reviewed by the YANG Sensei, who will make the final decision for admittance.

Best Practices & Guidelines

Broadband Forum OD-360 defines the "Best Current Practices for BBF YANG" and is maintained by the YANG Ninjas. 

• These are derived from the IETF Guidelines defined in RFC 6087 and subsequently RFC 8407 but have been augmented with Forum specific guidelines
• Currently "enforcement" of these guidelines relies on editors/members to be aware of the guidelines and ensure they are met in any YANG model developed in the Forum
• Just asking for a YANG Doctor review, while beneficial, would not fully ensure all BBF YANG guidelines are met

Please refer to the following Wiki page: OD-360 - BBF YANG Best Current Practices

Responsibilities

Responsibilities of a YANG Ninja include:

• Review BBF YANG models for consistency and adherence to OD-360
• Contribute to the further development of OD-360
• Ensure consistency in the YANG models defined within a Work Area as well as across Work Areas

It is not expected that normal duties consume more than 8 hours per month.

Review Process

The review process for ongoing development is as follows:

• At least one YANG Ninja is required to approve any YANG related pull request before merging.
• The reviewing YANG Ninja must not be a contributor to the pull request.

The review process for publication is as follows:

• Each Working Text which defines YANG models will need to go through a formal group review before publication
• The final, formal review will occur during Straw Ballot, however reviews during development are recommended
• The review must be done by at least 2 YANG Ninjas, whose comments are aligned and consolidated prior to submission as Straw Ballot comments
• A group member who is responsible for a review must not also be an editor of the WT under review 

Related Work

• Common YANG Work Area - Archived