OpenPOWER Library

 Preface

 1. Conventions

The OpenPOWER Foundation documentation uses several typesetting conventions.

 Notices

Notices take these forms:

[Note]Note

A handy tip or reminder.

[Important]Important

Something you must be aware of before proceeding.

[Warning]Warning

Critical information about the risk of data loss or security issues.

 Changes

At certain points in the document lifecycle, knowing what changed in a document is important. In these situations, the following conventions will used.

  • New text will appear like this. Text marked in this way is completely new.

  • Deleted text will appear like this. Text marked in this way was removed from the previous version and will not appear in the final, published document.

  • Changed text will appear like this. Text marked in this way appeared in previous versions but has been modified.

 Command prompts

In general, examples use commands from the Linux operating system. Many of these are also common with Mac OS, but may differ greatly from the Windows operating system equivalents.

For the Linux-based commands referenced, the following conventions will be followed:

$ prompt

Any user, including the root user, can run commands that are prefixed with the $ prompt.

# prompt

The root user must run commands that are prefixed with the # prompt. You can also prefix these commands with the sudo command, if available, to run them.

 Document links

Document links frequently appear throughout the documents. Generally, these links include a text for the link, followed by a page number in parenthesis. For example, this link, Preface, references the Preface chapter on page .

 2. Document change history

This version of the guide replaces and obsoletes all earlier versions.

The following table describes the most recent changes:

Revision DateSummary of Changes

August 27, 2018

Version 1.2 additional updates:

  • Add a section on circumventing Java AWT exception.

  • Add information on key document tags which need update for new documents.

  • Extend information on modifying an existing document to include a step-by-step description of how to get started.

  • Rename the template directory to doc_dev_guide.

April 11, 2018

Version 1.2 updates:

  • Extend the Getting Started section to include a first document build.

  • Add a section on document packaging for publish in the Publishing OpenPOWER Documents section.

  • Add examples for background color in tables, and variablelists.

February 17, 2017

Version 1.1.0 updates:

  • Enhancements document creation to address project creation and update process.

  • Add "git" error to troubleshooting sections until JAR dependency removed.

  • Add optional font installation step to getting started.

  • Provide samples of how to access symbols by value, including extension for new symbol library.

  • Provide example usage of OPF Docbook extensions -- hard page breaks, soft line breaks, font-size changes, setting text color, and explicitly using symbol library.

  • Extend explanation of versioning policy.

  • Correct, improve miscellenous wording and grammar.

September 13, 2016

  • Version 1.0.1: Minor updates to guide naming.

August 25, 2016

  • Version 1.0.0: Document approval for publish

April 28, 2016

  • Version 0.9.5: Removal of confidentiality and preview of change notations for final review by TSC.

March 21, 2016

  • Version 0.9.4: Review version for TSC.

February 25, 2016

  • Version 0.9.3: Technical and process updates. Addition of documentation lifecycle and git command cheat sheets.

February 25, 2016

  • Version 0.9.2: Technical and process updates. Explanation of project structure.

January 25, 2016

  • Version 0.9.1: Technical and process updates.

August 20, 2015

  • Version 0.9: Draft for format review with TSC.

September 3, 2014

  • Creation based on OpenStack documentation


loading table of contents...