This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
openchain:openchain-specification-wiki-page [2018/05/17 15:13] mgisi [Specification Version Development/Release Process] |
openchain:openchain-specification-wiki-page [2019/08/05 00:08] mgisi [Version 2.0 Changes Over Previous Version 1.2] |
||
---|---|---|---|
Line 1: | Line 1: | ||
The OpenChain Specification is available for everyone to review, adopt and to submit suggestions for improvement. You can send questions and feedback to the {{https://lists.linuxfoundation.org/mailman/listinfo/openchain-specification | mailing list}} or directly the Specification Team Chair, Mark Gisi (Mark.Gisi@WindRiver.com) if you prefer to provide comments anonymously. | The OpenChain Specification is available for everyone to review, adopt and to submit suggestions for improvement. You can send questions and feedback to the {{https://lists.linuxfoundation.org/mailman/listinfo/openchain-specification | mailing list}} or directly the Specification Team Chair, Mark Gisi (Mark.Gisi@WindRiver.com) if you prefer to provide comments anonymously. | ||
- | {{:openchain:openchainspec-current.pdf| OpenChain Specification 1.2}} | + | {{:openchain:openchainspec-current.pdf| OpenChain Specification 2.0}} |
The specification Frequently Asked Questions (FAQs) can be found here:{{https://wiki.linuxfoundation.org/openchain/specification-questions-and-answers| Spec FAQs}}. Answers to the FAQs can help understanding how to interpret the specification. | The specification Frequently Asked Questions (FAQs) can be found here:{{https://wiki.linuxfoundation.org/openchain/specification-questions-and-answers| Spec FAQs}}. Answers to the FAQs can help understanding how to interpret the specification. | ||
- | ==== Version 1.3 (Latest) Draft ==== | + | ==== Past Versions of the Specification ==== |
+ | * {{:openchain:openchainspec-1.0.pdf| OpenChain Specification 1.0}} | ||
+ | * {{:openchain:openchainspec-1.1.pdf| OpenChain Specification 1.1}} | ||
+ | * {{:openchain:openchainspec-1.2.pdf| OpenChain Specification 1.2}} | ||
+ | * {{:openchain:openchainspec-2.0.pdf| OpenChain Specification 2.0 (current)}} | ||
- | We are currently working on the next version of the specification (version 1.2). You can find the latest draft here: | + | ==== Version 2.0 Changes Over Previous Version 1.2 ==== |
- | {{openchainspec-1.3.draft.pdf| Next Draft Version 1.3}} | + | |
+ | You can find the current draft version here: | ||
+ | |||
+ | * {{OpenChainSpec-2.1.draft.pdf | Current Draft (Version 2.1)}} | ||
==== Contributing to the Specification ==== | ==== Contributing to the Specification ==== | ||
Line 14: | Line 21: | ||
{{https://wiki.linuxfoundation.org/openchain/specification-questions-and-answers| Spec FAQs}}. You can join the Specification {{https://lists.linuxfoundation.org/mailman/listinfo/openchain-specification | mailing list}} and, review and record feedback on the current version of the specification using {{ https://github.com/OpenChain-Project/Specification/issues | github issue tracking}}. | {{https://wiki.linuxfoundation.org/openchain/specification-questions-and-answers| Spec FAQs}}. You can join the Specification {{https://lists.linuxfoundation.org/mailman/listinfo/openchain-specification | mailing list}} and, review and record feedback on the current version of the specification using {{ https://github.com/OpenChain-Project/Specification/issues | github issue tracking}}. | ||
- | ==== Specification Version Development/Release Process ==== | + | ==== Specification Development/Release Process ==== |
- | - Hold a kickoff meeting and review the Guiding Principles | + | For a given version of the specification the development process steps include: |
+ | - Hold a kickoff meeting and revisit the {{https://wiki.linuxfoundation.org/openchain/specification-questions-and-answers#what-are-the-specification-guiding-principles | Specification Guiding Principles}}. | ||
- We accept and discuss feedback from anyone who wants to participate either at the working group meetings or on the {{https://lists.linuxfoundation.org/mailman/listinfo/openchain-specification | spec mailing list}}. | - We accept and discuss feedback from anyone who wants to participate either at the working group meetings or on the {{https://lists.linuxfoundation.org/mailman/listinfo/openchain-specification | spec mailing list}}. | ||
- | - Currently an annual release cadence maintained (which is subject change for a given release cycle). | + | - Currently an annual release cadence is followed (which may change for a given release). Any cadence changes will be announced on the {{https://lists.linuxfoundation.org/mailman/listinfo/openchain-specification | spec mailing list}}. |
- | - Suggestions are tracked in the spec project's {{ https://github.com/OpenChain-Project/Specification/issues | github issue tracking list}}. | + | - Suggestions are tracked in the specification's {{ https://github.com/OpenChain-Project/Specification/issues | github issue tracking list}}. |
- | - A draft of the accepted modifications and additions are published monthly in an {{openchainspec-1.3.draft.pdf| updated draft document}}. | + | - A draft of the accepted modifications and additions are published monthly in an {{openchainspec-2.0.draft.pdf| updated draft document}}. |
- | - Public Comments Period - Six weeks prior to the release date we circulate a near final version seeking public comments for 30 days. During this period we accept only minor updates such as typos, grammar corrections and wordsmith changes that do not change the semantics of the content. We do not accept any material changes during this period. All other feedback and recommendations are queue for consideration during the next version release cycle. | + | - Public Comments Period - Six weeks prior to the target release date we circulate a near final version seeking public comments for 30 days. During this period we accept only minor updates such as typos, grammar corrections and wordsmith recommendations that do not change the semantics of the content. We do not accept any material changes during this period. All other feedback and recommendations are queue for consideration during the next version release cycle. |
- | - Freeze Period - Two weeks prior to release we freeze the draft and allow one last review. This is to allow everyone to review the minor changes made during the public comments period. | + | - Freeze Period - Two weeks prior to release we freeze the draft and allow one last review for 14 days. This is to enable everyone to review any changes made during the Public Comments period. |
- | - If there was enough concern (consensus) over any changes made during the public comments period we would hold another 30 day public comments round followed by another two week freeze period. We will ask anyone with significant reservations on the final draft to state their position/concerns via the spec mailing list or to the spec working group led (if they want to remain anonymous) . We would repeat this process until we had major agreement (consensus) on a final version | + | - If a consensus expresses concerns over any changes made during the Public Comments period we would i) make changes to accommodate those concerns followed by ii) an additional 14 day Public Comments period; followed by iii) another 14 day Freeze period. Anyone with significant reservations on the final draft should state their position/concerns via the spec mailing list. The changes will be accepted once we achieve consensus for the final draft. |
+ | - In the event we do not have consensus on the final version - we would repeat the following cycle until we have consensus: i) accommodate changes to address majority concerns; ii) 14 day Public Comments period; followed by iii) a 14 day Freeze period cycle. | ||
==== Translations ==== | ==== Translations ==== | ||
Multiple language translations of the specification greatly facilitate adoption. We have a policy document describing the process needed to i) facilitate the creation of official translations and ii) preserve the accuracy and completeness of the specification. Details of of the policy and process are available on the following [[ https://wiki.linuxfoundation.org/openchain/spec-translations |wiki page]] | Multiple language translations of the specification greatly facilitate adoption. We have a policy document describing the process needed to i) facilitate the creation of official translations and ii) preserve the accuracy and completeness of the specification. Details of of the policy and process are available on the following [[ https://wiki.linuxfoundation.org/openchain/spec-translations |wiki page]] |