Modifying an existing document
To begin editing an existing document, you must first clone two projects -- the master document framework project and
the specific document project. Begin by cloning the master document as described in .
Once complete, obtain a copy of the desired document by cloning its project. For example, to clone this document,
Documentation Development Guide, from the
public OpenPOWER Foundation git repository, use this
command:$ git clone https://github.com/OpenPOWERFoundation/Docs-Template.git
Cloning into 'Docs-Template'...
Username for 'https://github.com': my_userid
Password for 'https://my_userid@github.com': my_password
remote: Counting objects: 62, done.
remote: Compressing objects: 100% (10/10), done.
remote: Total 62 (delta 2), reused 0 (delta 0), pack-reused 52
Unpacking objects: 100% (62/62), done.
Checking connectivity... done.
$
To build a specific document such as this guide, follow these steps from the directory where
you just cloned:$ cd Docs-Template/template
$ mvn clean
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building OpenPOWER Template Guide 1.0.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ openpower-template-guide ---
[INFO] Deleting ~/Docs-Template/template/target
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 0.353s
[INFO] Finished at: Wed Feb 25 12:54:47 CST 2015
[INFO] Final Memory: 3M/7M
[INFO] ------------------------------------------------------------------------
$ mvn generate-sources
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building OpenPOWER Template Guide 1.0.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- openpowerdocs-maven-plugin:1.0.0:generate-webhelp (generate-webhelp) @ openpower-template-guide ---
[INFO] Processing input file: bk_main.xml
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 20.361s
[INFO] Finished at: Wed Feb 25 12:55:15 CDT 2015
[INFO] Final Memory: 30M/390M
[INFO] ------------------------------------------------------------------------
$
The permutations of Maven invocations may be combined into one operation where the parameters are specified in the order
in which one wishes to execute them. Thus, the command mvn clean generate-sources would accomplish the
same thing as the above sequence of commands.
If all goes well, the generated pdf should be available in ~/Docs-Template/template/target/docbkx/webhelp/template-guide/.
For assistance correcting commmon build failures, see .
Projects may contain multiple documents. While specific documents can be built by executing a
mvn clean generate-sources in the specific document directory, executing this command in
the base project directory will build all projects identified in the <module> list in the
top-level pom.xml file, known as the "Workgroup POM".
You are now ready to begin making updates. Before diving deeply into new text,
you may want to review
to ensure that proper Work Product,
Work Process, and security values are selected for your document.