CAPI-SNAP-Doc/README.md

# Master Template Document Project for OpenPOWER Foundation Documentation
This repository hold the source for the master document template for 
OpenPOWER Foundation. The PDF and HTML generated from the doc/template/ 
directory build a document that both describes how to build a new
document and contains examples and directions on how to do it.

To build this project, one must ensure that the Docs-Master project has
also been cloned at the same directory level as the Docs-Template project.
This can be accomplished with the following steps:

1. Clone the master documentation project (Docs-Master) using the following command:

  ```
  $ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git
  ```
  
2. Clone this project (Docs-Template) using the following command:

  ```
  $ git clone https://github.com/OpenPOWERFoundation/Docs-Template.git
  ```
  
3. Build the project with these commands:
  ```
  $ cd Docs-Template
  $ mvn clean generate-sources
  ```

The online version of the document can be found in the OpenPOWER Foundation
Document library at [TBD](http://openpowerfoundation.org/docs)

The project which control the look and feel of the document is the 
[Docs-Maven-Plugin project](https://github.com/OpenPOWERFoundation/Docs-Maven-Plugin).

To contribute to the OpenPOWER Foundation template document project, contact Jeff Scheel \([scheel@us.ibm.com](mailto://scheel@us.ibm.com)\) or 
Jeff Brown \([jeffdb@us.ibm.com](mailto://jeffdb@us.ibm.com)\).
Initial source priming The OpenPOWER Foundation master template document is based loosely on the OpenStack Manuals project in GitHub at https://github.com/openstack/openstack-manuals Many of the examples in the documentation were created by another IBM employee, Jeff Brown (jeffdb@us.ibm.com). Reviews of the content have been handled by the OpenPOWER Foundation Technical Steering Committee and the System Software Work Group. While the format of the document is in good shape, the technical details remain to be verified and the Docbook source reviewed before publishing version 1.0. However, this is a good starting point. Signed-off-by: Jeff Scheel <scheel@us.ibm.com> 8 years ago			`# Master Template Document Project for OpenPOWER Foundation Documentation`
			`This repository hold the source for the master document template for`
			`OpenPOWER Foundation. The PDF and HTML generated from the doc/template/`
			`directory build a document that both describes how to build a new`
			`document and contains examples and directions on how to do it.`

Restructure Project to use Docs-Master Project This project has now been built to longer contain common files nor the master POM file and now instead relies on the ../Docs-Master/ structure when building. As such, the doc/common directory was removed and the remaining files in doc/ were promoted to main level. Then, the top POM file was converted to a "minimal" POM referencing the master-pom in ../Docs-Master/. Finally, the template/ directory required a slight update to the POM file (new name for parent minimal POM, "workgroup-pom") and updated locations (../../Docs-Master/common) for the common preface and appendix files in the book file (bk_main.xml). For completeness, the README file was updated to ensure users of the project understand it no longer is self-contained and must rely on the Docs-Master project. Signed-off-by: Jeff Scheel <scheel@us.ibm.com> 8 years ago			`To build this project, one must ensure that the Docs-Master project has`
			`also been cloned at the same directory level as the Docs-Template project.`
			`This can be accomplished with the following steps:`

Update README.md - Corrected formatting of nested code in bulleted list. - Corrected wording to explicitly reference Docs-Template project 8 years ago			`1. Clone the master documentation project (Docs-Master) using the following command:`

			```
			`$ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git`
			```

			`2. Clone this project (Docs-Template) using the following command:`

			```
			`$ git clone https://github.com/OpenPOWERFoundation/Docs-Template.git`
			```

Restructure Project to use Docs-Master Project This project has now been built to longer contain common files nor the master POM file and now instead relies on the ../Docs-Master/ structure when building. As such, the doc/common directory was removed and the remaining files in doc/ were promoted to main level. Then, the top POM file was converted to a "minimal" POM referencing the master-pom in ../Docs-Master/. Finally, the template/ directory required a slight update to the POM file (new name for parent minimal POM, "workgroup-pom") and updated locations (../../Docs-Master/common) for the common preface and appendix files in the book file (bk_main.xml). For completeness, the README file was updated to ensure users of the project understand it no longer is self-contained and must rely on the Docs-Master project. Signed-off-by: Jeff Scheel <scheel@us.ibm.com> 8 years ago			`3. Build the project with these commands:`
Update README.md - Corrected formatting of nested code in bulleted list. - Corrected wording to explicitly reference Docs-Template project 8 years ago			```
			`$ cd Docs-Template`
			`$ mvn clean generate-sources`
			```
Restructure Project to use Docs-Master Project This project has now been built to longer contain common files nor the master POM file and now instead relies on the ../Docs-Master/ structure when building. As such, the doc/common directory was removed and the remaining files in doc/ were promoted to main level. Then, the top POM file was converted to a "minimal" POM referencing the master-pom in ../Docs-Master/. Finally, the template/ directory required a slight update to the POM file (new name for parent minimal POM, "workgroup-pom") and updated locations (../../Docs-Master/common) for the common preface and appendix files in the book file (bk_main.xml). For completeness, the README file was updated to ensure users of the project understand it no longer is self-contained and must rely on the Docs-Master project. Signed-off-by: Jeff Scheel <scheel@us.ibm.com> 8 years ago
Initial source priming The OpenPOWER Foundation master template document is based loosely on the OpenStack Manuals project in GitHub at https://github.com/openstack/openstack-manuals Many of the examples in the documentation were created by another IBM employee, Jeff Brown (jeffdb@us.ibm.com). Reviews of the content have been handled by the OpenPOWER Foundation Technical Steering Committee and the System Software Work Group. While the format of the document is in good shape, the technical details remain to be verified and the Docbook source reviewed before publishing version 1.0. However, this is a good starting point. Signed-off-by: Jeff Scheel <scheel@us.ibm.com> 8 years ago			`The online version of the document can be found in the OpenPOWER Foundation`
			`Document library at [TBD](http://openpowerfoundation.org/docs)`

			`The project which control the look and feel of the document is the`
			`[Docs-Maven-Plugin project](https://github.com/OpenPOWERFoundation/Docs-Maven-Plugin).`

			`To contribute to the OpenPOWER Foundation template document project, contact Jeff Scheel \([scheel@us.ibm.com](mailto://scheel@us.ibm.com)\) or`
			`Jeff Brown \([jeffdb@us.ibm.com](mailto://jeffdb@us.ibm.com)\).`