Tools team A. Rousskov Internet-Draft The Measurement Factory Expires: July 2, 2005 January 1, 2005 Requirements for Providing Information on IETF Internet-Drafts draft-ietf-tools-draft-info-00 Status of this Memo This document is an Internet-Draft and is subject to all provisions of section 3 of RFC 3667. By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she become aware will be disclosed, in accordance with RFC 3668. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. This Internet-Draft will expire on July 2, 2005. Copyright Notice Copyright (C) The Internet Society (2005). Abstract This document specifies what information IETF should provide about an IETF Internet-Draft. Information requirements cover submitted, posted, published, expired, and other personal or Working Group drafts. Rousskov Expires July 2, 2005 [Page 1] Internet-Draft Draft Information Requirements January 2005 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 2. State of this draft version . . . . . . . . . . . . . . . . . 3 3. Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 4. Notation and Terminology . . . . . . . . . . . . . . . . . . . 3 5. Status quo . . . . . . . . . . . . . . . . . . . . . . . . . . 4 6. Requirements . . . . . . . . . . . . . . . . . . . . . . . . . 4 6.1 Draft metadata . . . . . . . . . . . . . . . . . . . . . . 5 6.2 Available draft versions . . . . . . . . . . . . . . . . . 5 6.3 Change history . . . . . . . . . . . . . . . . . . . . . . 5 6.4 Notification functionality . . . . . . . . . . . . . . . . 5 6.5 Version metadata . . . . . . . . . . . . . . . . . . . . . 5 6.6 Version formats . . . . . . . . . . . . . . . . . . . . . 5 7. Email interface . . . . . . . . . . . . . . . . . . . . . . . 5 8. Implementation stages . . . . . . . . . . . . . . . . . . . . 5 9. Security Considerations . . . . . . . . . . . . . . . . . . . 5 10. IANA Considerations . . . . . . . . . . . . . . . . . . . . 6 11. Compliance . . . . . . . . . . . . . . . . . . . . . . . . . 6 A. Comparison with current procedures . . . . . . . . . . . . . . 6 B. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 6 C. Change log . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Author's Address . . . . . . . . . . . . . . . . . . . . . . . 6 Intellectual Property and Copyright Statements . . . . . . . . 7 Rousskov Expires July 2, 2005 [Page 2] Internet-Draft Draft Information Requirements January 2005 1. Introduction Public Internet-Drafts are primary means of structured communication within IETF. The information that IETF currently provides about any given draft is decentralized and often insufficient to facilitate on-going draft review and use by IETFers and 3rd parties. The IETF Tools team recommends creation of a single, authoritative, and comprehensive IETF source for draft information. This document specifies what information IETF should provide about a draft and, to a limited extent, how that information needs to be provided. Most, if not all, requirements in this document are inspired by existing sources of draft information, both on official IETF web sites and sites administered outside of IETF. 2. State of this draft version This draft version does not contain much meat and cannot represent Tools team consensus. Thus, this draft version is not meant for review. However, the Tools team is interested in (a) high-level comments about what information needs to be provided by IETF and (b) pointers to existing sites providing useful draft information. Please post your comments on tools-discuss@ietf.org mailing list or email them directly to the author. RFC Editor Note: Please remove this section for the final publication of the document. It has been inspired by draft-rousskov-newtrk-id-state and related NEWTRK WG discussions. 3. Scope The document scope is a single Internet-Draft, including multiple versions and formats of the same draft. Requirements cover submitted, posted, published, expired, and unknown personal or Working Group drafts. The interfaces required to locate a draft or correlate information about multiple drafts are out of scope. 4. Notation and Terminology The following terms are to be interpreted according to their definitions below. posted draft: A draft accepted into public IETF draft repository and, hence, publicly available on IETF web site. Posting of a draft does not imply any IETF or IESG review and endorsement. Rousskov Expires July 2, 2005 [Page 3] Internet-Draft Draft Information Requirements January 2005 draft version: A meant-to-be-public snapshot of an Internet-Draft with a meant-to-be-unique version number. Also known as "draft revision". draft format: Any draft source or presentation format, including original and preprocessed XML, original or generated plain text as well as PDF, PostScript, and HTML formats. primary draft format: The first available draft format from the following list: plain text, PDF, PostScript, or XML. WG draft: A draft which identifier (a.k.a. filename) is known and starts with "draft-ietf-". individual draft: A draft other than a WG draft. Normative requirements in this document are English phrases ending with an "(Rnnn/s)" mark, where "nnn" is a unique requirement number, and "s" is a single letter code ("a", "b", or "c") specifying the implementation stage for the requirement. Implementation stages are documented in Section 8. This document does not specify how the implementation must obtain necessary draft information and does not require specific information rendering techniques. However, implementation hints or examples are often useful. To avoid mixup with normative requirements, such hints and examples are marked with a "Hint:" prefix. Implementation hints do not carry any normative force, and a different implementation may be the best choice. 5. Status quo This section summarizes what information about a draft is usually available to IETFers at the time of writing. TBD 6. Requirements The following information should be available about a given draft: o draft status (similar to what ID tracker does now) o draft meta-data (XXX: expand) o available draft versions o change history (for drafts with multiple versions available) Rousskov Expires July 2, 2005 [Page 4] Internet-Draft Draft Information Requirements January 2005 o "notify me when this draft changes" functionality For each available draft version, the following information should be provided: o version meta-data (XXX: expand) o primary version format (always available) o all other available version formats (if any) 6.1 Draft metadata o authors information o WG name o email address for draft discussion and comments o "obsoletes X" or "renamed to Y" information All draft metadata must be available in format(s) suitable for human consumtion and in XML format. 6.2 Available draft versions 6.3 Change history 6.4 Notification functionality 6.5 Version metadata 6.6 Version formats 7. Email interface TBD 8. Implementation stages TBD. 9. Security Considerations TBD. Rousskov Expires July 2, 2005 [Page 5] Internet-Draft Draft Information Requirements January 2005 10. IANA Considerations None. 11. Compliance TBD. Appendix A. Comparison with current procedures This section summarizes major differences between information currently provided by IETF and what is being proposed, including violations of the current IETF rules. o Currently, IETF provides only the latest draft version. This document requires providing all unexpired versions. This change allows to maintain a change history useful for draft review and discussion. The change does not seem to contradict written IETF rules and principles. If an experiment with providing unexpired but obsolete versions does not cause significant problems, the IETF rules might be modified to also provide all draft versions for unexpired drafts and, later, all draft versions ever posted. Appendix B. Acknowledgments Special thanks to Marshall Rose for his xml2rfc tool. Appendix C. Change log RFC Editor Note: This section is to be removed during the final publication of the document. Internal WG revision control ID: $Id$ version 00 * Initial version. Author's Address Alex Rousskov The Measurement Factory EMail: rousskov@measurement-factory.com URI: http://www.measurement-factory.com/ Rousskov Expires July 2, 2005 [Page 6] Internet-Draft Draft Information Requirements January 2005 Intellectual Property Statement 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. Disclaimer of Validity 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 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. Copyright Statement Copyright (C) The Internet Society (2005). 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. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Rousskov Expires July 2, 2005 [Page 7]