To begin contributing to the OpenPOWER Foundation documentation, the following steps must be completed: Once complete, you can proceed to either or as needed.

Only two tools are required to update documentation, git and maven. Git manages the documentation source and maven provides the build framework to create the published content in PDF and html form. Installation steps for these tools varies by operating system. On Debian-based Linux operating systems (Ubuntu and Debian), install maven and git as follows: # apt-get install git # apt-get install maven On RPM-based Linux operating systems (Fedora, RHEL, openSUSE, SLES), install maven and git as follows: # yum install git # yum install maven On Mac OS X, use Macports to install maven and git as follows: # port install git # port install maven3 or use Homebrew to install maven and git as follows: $ brew install git $ brew install maven For information on how to setup the environment on Windows, see the following websites: git for Windows - http://msysgit.github.io/ Maven on Windows - http://maven.apache.org/guides/getting-started/windows-prerequisites.html Modification of documentation source files requires a text editor. While standard editors like vim, emacs, or gedit can be used, it is highly recommended that an editor be used which highlights XML or Docbook syntax. If your favorite editor does not include an extension or plugin to accomplish this, you might consider using Bluefish to edit your docbook files. Details on this editor can be found at http://bluefish.openoffice.nl/index.html.

The OpenPOWER Foundation documentation utilizes opensource fonts known as the Chrome OS core fonts or Croscore fonts. The three TrueType fonts (TTFs) in this family Arimo (sans-serif), Tinos (serif), and Cousine (monospace). While not strictly required to have these fonts on your system, it can be helpful when designing graphics and other images to have them installed on your development system. Only two tools are required to update documentation, git and maven. Git manages the documentation source and maven provides the build framework to create the published content in PDF and html form. Installation steps for these tools varies by operating system. On Debian-based Linux operating systems (Ubuntu and Debian), install Croscore fonts as follows: # apt-get install fonts-croscore On RPM-based Linux operating systems (Fedora, RHEL, openSUSE, SLES), install Croscore fonts as follows: # yum install google-croscore-fonts On Mac OS X and Windows systems, use a font website to download and install the Croscore fonts individually. Most of these sites provide directions for Mac OS and Windows.

All OpenPOWER project documentation is maintained in GitHub trees, public and private. The first step to creating documentation will be joining the GitHub community. To join the GitHub community, apply at https://github.com/join. The OpenPOWER Foundation documentation trees are grouped in the OpenPOWER Foundation project at https://github.com/OpenPOWERFoundation. Everyone should be able to see and access public trees like Docs-Master. However, if you will be participating in private OpenPOWER Foundation trees, you will need to request access from the Technical Steering Committee Chair, tsc-chair@openpowerfoundation.org. To learn more about using git, see the online article in GitHub Help, "Good Resources for Learning Git and GitHub." at https://help.github.com/articles/good-resources-for-learning-git-and-github/.

To successfully build OpenPOWER Foundation documents, common document files must be in place in addition to the specific document files. These common files are obtained by cloning the OpenPOWER Foundation public project Docs-Master. To clone the OpenPOWER Foundation master document framework, use the clone git command:$ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git Cloning into 'Docs-Master'... remote: Counting objects: 24, done. remote: Compressing objects: 100% (18/18), done. remote: Total 24 (delta 6), reused 20 (delta 5), pack-reused 0 Unpacking objects: 100% (24/24), done. Checking connectivity... done. $ More information can be found about the Docs-Master project online at https://github.com/OpenPOWERFoundation/Docs-Master. Additional details about the OpenPOWER Foundation documentation structure are explained in of this document.

The final step of setting up your environment to perform the first build. The following steps are recommended: Clone the Documentation Development Guide (this document) as source from which to build. To accomplish this, issue the following command in the same directory as as the master document clone from . $ git clone https://github.com/OpenPOWERFoundation/Docs-Template.git Cloning into 'Docs-Template'... remote: Counting objects: 253, done. remote: Total 253 (delta 0), reused 0 (delta 0), pack-reused 253 Receiving objects: 100% (253/253), 468.94 KiB | 0 bytes/s, done. Resolving deltas: 100% (151/151), done. Checking connectivity... done. $ Change the working directory into the source directory for the Documentation Development Guide. $ cd Docs-Template/doc_dev_guide Docs-Template/doc_dev_guide$ Build the document in Maven.Docs-Template/doc_dev_guide$ mvn generate-sources [INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building Documentation Development Guide 1.0.0-SNAPSHOT [INFO] ------------------------------------------------------------------------ [INFO] [INFO] --- openpowerdocs-maven-plugin:1.1.0:generate-webhelp (generate-webhelp) @ openpower-template-guide --- [INFO] Processing input file: bk_main.xml [WARNING] Property not found in com.agilejava.docbkx.maven.DocbkxWebhelpMojo [WARNING] Property not found in com.agilejava.docbkx.maven.DocbkxWebhelpMojo [WARNING] Property not found in com.agilejava.docbkx.maven.DocbkxWebhelpMojo [WARNING] Property not found in com.agilejava.docbkx.maven.DocbkxWebhelpMojo Feb 27, 2018 11:43:28 AM org.apache.fop.apps.FopFactoryConfigurator configure INFO: Default page-height set to: 11in Feb 27, 2018 11:43:28 AM org.apache.fop.apps.FopFactoryConfigurator configure ...snip... [INFO] Applying customization parameters <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> Parsing: /home/scheel/mydocs/Docs-Template/doc_dev_guide/target/docbkx/webhelp/doc-devel-guide/content/section_cloning_project.html ...snip... The created index files are located in /home/scheel/mydocs/Docs-Template/doc_dev_guide/target/docbkx/webhelp/doc-devel-guide/content/search/.js [INFO] See /home/scheel/mydocs/Docs-Template/doc_dev_guide/target/docbkx/webhelp/bk_main for generated file(s) [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 31.547 s [INFO] Finished at: 2018-02-27T11:43:45-06:00 [INFO] Final Memory: 83M/729M [INFO] ------------------------------------------------------------------------ Docs-Template/doc_dev_guide$ The first time one builds in a Maven environment, the build time will be noticeably long due to JAR file downloads associated with the new Maven project types. In future builds, these JAR files will only be downloaded when they are updated. As such, one should both allow for this extra time and not be discouraged by the duration of the first build. Once complete, there should be a single directory in the target/docbkx/webhelp/ directory. For the Docs-Template project, that directory is doc-devel-guide. Inside this directory will be both the PDF file and the index.html file for the HTML document. To verify this for the Documentation Development Guide, perform these commands: Docs-Template/doc_dev_guide$ cd target/docbkx/webhelp/ Docs-Template/doc_dev_guide/target/docbkx/webhelp$ ls doc-devel-guide Docs-Template/doc_dev_guide/target/docbkx/webhelp$ cd doc-devel-guide Docs-Template/doc_dev_guide/target/docbkx/webhelp/doc-devel-guide$ ls bookinfo.xml common content doc-devel-guide-20180227.pdf favicon.ico index.html webapp Now, you are ready to begin working on your own document. Useful information on how to proceed can be found in and .