OpenPOWER Library

 1.6.3. Understanding the specific steps of Standard Work Product documents

Section 1.6.2, “Navigating the OpenPOWER Foundation documentation publishing process” provides an overview of the work flow of both Non-Standard and Standard Work Products. While Figure 1.4, “Document work flow for Non-Standard Track Work Products” is rather straightforward, Figure 1.5, “Document work flow for Standard Track Work Products” is larger and more complex. In an attempt to simplify the process, the following figures decompose each state into just the actions needed to progress to the next step for Standard Track Work Products.

For detailed assistance with the development of Standard Track Work Products, select the figure which reflects your current document state. Then, follow the work flow to understand both the document settings and actions needed to progress to the next document state.

For documents either getting started as Work Group Specification Draft or having returned to this state for updates, reference the following figure. Documents in this state will have <workProduct>workgroupSpecification</workProduct> and <documentStatus>draft</documentStatus> in their document POM (pom.xml).

 

Figure 1.6. Document work flow for Standard Track Work Products in the Specification Draft State


To proceed from a Work Group Specification Draft to a Work Group Specification Review Draft, a document requires 3 approvals, in this order: sponsoring Work Group, Technical Steering Committee, and Board of Directors. Following these three approvals, the document POM (pom.xml) variable <documentStatus> should be set to review. In addition, the <security> variable may be set to public if the review is targeted to be public.

For documents currently in Work Group Specification Review Draft state (<workProduct>workgroupSpecification</workProduct> and <documentStatus>review</documentStatus>), consult this figure.

 

Figure 1.7. Document work flow for Standard Track Work Products in the Specification Review Draft State


To proceed from a Work Group Specification Review Draft to a Work Group Specification, a document requires a successful review and 3 approvals in this order: sponsoring Work Group, Technical Steering Committee, and Board of Directors. Following these three approvals, the document POM (pom.xml) variable <documentStatus> should be set to published. In addition, the <security> variable should be set to public if for public specifications.

For Work Group Specifications marked <workProduct>workgroupSpecification</workProduct> and <documentStatus>published</documentStatus>, see the next figure.

 

Figure 1.8. Document work flow for Standard Track Work Products in the Specification State


A document in the Work Group Specification state may return to a Work Group Specification Draft or proceed as a Candidate OpenPOWER Standard.

To make updates, the document returns to the Work Group Specification Draft state. To accomplish this, the <documentStatus> variable should be set to draft and <security> should be set to either public or workgroupConfidential.

To proceed to a Candidate OpenPOWER Standard, a document requires 3 approvals, in this order: sponsoring Work Group, Technical Steering Committee, and Board of Directors. Following these three approvals, the <workProduct> variable should be set to candidateStandard and <security> should be set to public.

For documents currently in Work Group Candidate OpenPOWER Standard state (<workProduct>candidateStandard</workProduct> and <documentStatus>published</documentStatus>), reference the following figure.

 

Figure 1.9. Document work flow for Standard Track Work Products in the Candidate OpenPOWER Standard State


A document in the Work Group Candidate OpenPOWER Standard state may proceed in two directions, back to a Work Group Specification Draft or on to a Candidate OpenPOWER Standard.

To make updates to a Work Group Candidate OpenPOWER Standard document, the document returns to the Work Group Specification Draft state. To accomplish this, the <documentStatus> variable should be set to draft and <security> should be set to either public or workgroupConfidential depending on how the Work Group handles document drafts.

To proceed to an OpenPOWER Standard, a document requires a successful review and a single approval from the Board of Directors. Following this approval, the document POM (pom.xml) variable <workProduct> should be set to openpowerStandard.


loading table of contents...