RFC 5249

Templates for Internet-Drafts Containing MIB Modules ✨

Okay bestie, let's get into it 💅 This one is a Best Current Practice (BCP 139), so it's the official "do it this way" guidance, not just a suggestion 🎀 It was written by D. Harrington (editor) from Huawei Technologies (USA) in July 2008, and it's the Network Working Group's document, Request for Comments 5249 🦋

The title block says it doesn't obsolete or update any other RFCs, so it's a standalone vibe 🌸

Heads up, the status is BCP, and the memo asks for discussion and suggestions for improvements 🫶

Status of This Memo

This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Distribution of this memo is unlimited. 💜

Abstract

This memo references three annotated templates for IETF documents that contain the definition of MIB modules. It is intended to reduce the work of the editors of such documents, making these documents more uniform and easier to read and review, thus furthering the quality of such documents and expediting their publication. ✨

Table of Contents

1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . 2
2.  Overview  . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3.  Security Considerations . . . . . . . . . . . . . . . . . . . . 3
4.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . . . 3
5.  Normative References  . . . . . . . . . . . . . . . . . . . . . 3

1. Introduction 🌈

Okay so this memo points to three annotated templates for IETF documents that define MIB modules 🧚 The whole point is to make the editors' lives easier, so these docs look more uniform and are easier to read and review. That's how the quality goes up and publication goes faster, which is iconic 👑

2. Overview 🍓

The MIB Doctors directorate made three templates just for Internet-Drafts with MIB modules 💖 You can grab them from the IETF Tools web site under the name "Templates for MIB Documents".

• The first one is an XML template for people using XML2RFC. It has some advice from RFC 4181 tucked into the comments 🎀
• The second is a text template with advice written right into the document 💅
• The third is a plain text template with zero advice 🫶

These templates exist to make MIB documents more consistent, which makes it way easier for a MIB Doctor and other IETF folks to review them 🦋 There are a bunch of MUSTs in the templates, especially in the advice. Those usually come from IESG requirements for Internet-Drafts, and MIB Doctors are likely to check for them, so don't skip them 😭

The templates hold the boilerplates that are required for IETF MIB module documents. Editors used to just copy an existing MIB document and call it a day, but that's messy because the boilerplates and other required stuff change over time 💀 So the templates are on the IETF Tools web site and get updated now and then to match the latest requirements. The most up-to-date versions live at http://www.tools.ietf.org.

The templates also have sections describing the purpose and organization of the MIB module, plus how it relates to other MIB modules. That helps MIB Doctors understand the module faster, so reviews move quicker 🌸

Editors should read RFC 4181 "Guidelines for Authors and Reviewers of MIB Documents" [RFC4181], which covers best current practices for editing MIB module documents 🧚

The templates don't include a template for the MIB module itself. Validation tools usually need the MIB module separated from the surrounding document, so the MIB Doctors think the simplest move is to develop the module outside the document, then drop it into the surrounding text that's written with the templates ✨

3. Security Considerations 🔥

This memo recommends templates for editing, and it has no direct impact on network security. The templates include boilerplates and related advice for writing the Security Considerations section of an Internet-Draft that documents a MIB module 💜

4. Contributors 👑

These templates are based on contributions from the MIB Doctors, especially Juergen Schoenwaelder, Dave Perkins, C.M. Heard, and Randy Presuhn 🫶

5. Normative References 🦋

[RFC4181]  Heard, C., "Guidelines for Authors and Reviewers of MIB
           Documents", BCP 111, RFC 4181, September 2005.

Author's Address 🎀

David Harrington (editor) Huawei Technologies (USA) 1700 Alma Drive, Suite 100 Plano, TX 75075 USA

Phone: +1 603 436 8634 EMail: dharrington@huawei.com

---

Full Copyright Statement 💅

Copyright (C) The IETF Trust (2008).

This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.

This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 🙈

Intellectual Property 🌈

The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. 🧚

Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. 💖

The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. ✨