OpenPOWER Library

 1.6.4. Packaging the document for publish

The OpenPOWER Foundation process for publishing documents from WordPress in the Resource Catalog on openpowerfoundatoin.org website has the following requirements:

  • The PDF and all HTML source must be bundled in a self-contained zip file.

  • The zip file is expected to contain a single directory in which the document PDF and index.html file are found.

  • The filename of the zip file must be the same name as the contained directory.

To create this package for the Documentation Development Guide, one would perform the following commands in Linux from the document source directory (.../Docs-Template/doc_dev_guide/):

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$ zip -rv doc-devel-guide.zip doc-devel-guide/
  adding: doc-devel-guide/	(in=0) (out=0) (stored 0%)
  adding: doc-devel-guide/favicon.ico	(in=806) (out=806) (stored 0%)
  adding: doc-devel-guide/index.html	(in=654) (out=385) (deflated 41%)
  ...snip...
  adding: doc-devel-guide/doc-devel-guide-20180406.pdf 	(in=413655) (out=305492) (deflated 26%)
  ...snip...
  adding: doc-devel-guide/common/	(in=0) (out=0) (stored 0%)
  adding: doc-devel-guide/common/main.js	(in=5674) (out=2119) (deflated 63%)
  ...snip...
  adding: doc-devel-guide/common/jquery/jquery-ui-1.8.2.custom.min.js 	(in=87032) (out=22729) (deflated 74%)
total bytes=3342807, compressed=1332882 -> 60% savings
Docs-Template/doc_dev_guide/target/docbkx/webhelp/doc-devel-guide$ ls
doc-devel-guide  doc-devel-guide.zip

For MacOS and Windows, the steps will be similar with slight variations on the command to create the zip file.

This zip file can be sent to the person managing the documents in the OpenPOWER Resource Catalog.


loading table of contents...