From b3344d0f489963df5be4c8e2ea72c091287fee54 Mon Sep 17 00:00:00 2001 From: Yurii Rashkovskii Date: Mon, 6 Jun 2016 10:17:09 +0700 Subject: [PATCH] Problem: RFCs metainformation can't be extracted programmatically Solution: Add YAML headers --- 1/README.md | 12 +++++++----- 2/README.md | 33 +++++++++++++++++++++++++++------ book.js | 2 +- 3 files changed, 35 insertions(+), 12 deletions(-) diff --git a/1/README.md b/1/README.md index 457d1d3..b8f19ca 100644 --- a/1/README.md +++ b/1/README.md @@ -1,11 +1,13 @@ -![stable](http://rfc.unprotocols.org/spec:2/COSS/stable.svg) +--- +domain: rfc.unprotocols.org +shortname: 1/C4 +name: Collective Code Construction Contract +status: stable +editor: Pieter Hintjens +--- The Collective Code Construction Contract (C4) is an evolution of the github.com [Fork + Pull Model](http://help.github.com/send-pull-requests/), aimed at providing an optimal collaboration model for free software projects. This is revision 2 of the C4 specification. -* Name: rfc.unprotocols.org/spec:1/C4 (1/C4) -* Editor: Pieter Hintjens -* Status: stable - This RFC is equivalent (with the exception of minor cosmetic changes) to [ZeroMQ RFC 42/C4](http://rfc.zeromq.org/spec:42) ## License diff --git a/2/README.md b/2/README.md index c7b9d29..918ad85 100644 --- a/2/README.md +++ b/2/README.md @@ -1,12 +1,18 @@ -![draft](http://rfc.unprotocols.org/spec:2/COSS/draft.svg) +--- +domain: rfc.unprotocols.org +shortname: 2/COSS +name: Consensus-Oriented Specification System +status: draft +editor: Yurii Rashkovskii +contributors: + - Pieter Hintjens + - André Rebentisch + - Alberto Barrionuevo + - Chris Puttick +--- This document describes a consensus-oriented specification system (COSS) for building interoperable technical specifications. COSS is based on a lightweight editorial process that seeks to engage the widest possible range of interested parties and move rapidly to consensus through working code. -* Name: rfc.unprotocols.org/spec:2/COSS (2/COSS) -* Editor: Yurii Rashkovskii -* Contributors: Pieter Hintjens , André Rebentisch , "Alberto Barrionuevo" , Chris Puttick -* Status: draft - This specification is based on the original [Digistan 1/COSS](http://www.digistan.org/spec:1/COSS) ## License @@ -147,3 +153,18 @@ It is RECOMMENDED to use color coding to indicate specification's status. Color * ![stable](http://rfc.unprotocols.org/spec:2/COSS/stable.svg) * ![deprecated](http://rfc.unprotocols.org/spec:2/COSS/deprecated.svg) * ![retired](http://rfc.unprotocols.org/spec:2/COSS/retired.svg) + + +## Appendix B. Metainformation + +It is RECOMMENDED that specification metadata is specified as a YAML header (where possible) or a separate YAML file. This will enable programmatic access +to specification metadata. + +| Key | Value | Type | Example | +|------------------|----------------------|--------|---------------------| +| **domain** | specification domain | string | rfc.unprotocols.org | +| **shortname** | short name | string | 2/COSS | +| **name** | full name | string | Consensus-Oriented Specification System | +| **status** | status | string | draft | +| **editor** | editor name/email | string | Yurii Rashkovskii | +| **contributors** | contributors | list | Pieter Hintjens , André Rebentisch , Alberto Barrionuevo , Chris Puttick | diff --git a/book.js b/book.js index a2a058b..c31b366 100644 --- a/book.js +++ b/book.js @@ -1,5 +1,5 @@ module.exports = { title: 'Unprotocols RFCs', gitbook: '>=3.0.0', - plugins: ['coss@1.0.4'] + plugins: ['coss@1.0.5'] };