OpenPOWER Library

 1.1.5. Building the first document

The final step of setting up your environment to perform the first build. The following steps are recommended:

  1. 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 Section 1.1.4, “Cloning master document information”.

    $ 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.
    $ 
  2. Change the working directory into the source directory for the Documentation Development Guide.

    $ cd Docs-Template/doc_dev_guide
    Docs-Template/doc_dev_guide$ 
  3. 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$ 
    [Note]Note

    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 Section 1.3, “Creating a new document” and Section 1.4, “Modifying an existing document”.


loading table of contents...