systemsoftware
/
CAPI-SNAP-Doc
33
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7 Commits
1 Branch
1 Tag
5.8 MiB
master
v0.9.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '6fe88129d1'
${ noResults }
Go to file
Jeff Scheel 6fe88129d1 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>
 		9 years ago
template Restructure Project to use Docs-Master Project 9 years ago
.gitignore Updated app_foundation.xml to use foundation doc public causeway urls. 9 years ago
LICENSE Initial source priming 9 years ago
README.md Restructure Project to use Docs-Master Project 9 years ago
pom.xml Restructure Project to use Docs-Master Project 9 years ago

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 this project (Docs-Master) using the following command:
$ git clone https://github.com/OpenPOWERFoundation/Docs-Master.git
  1. Clone the documentation project (my_project) using the following command:
$ git clone https://github.com/OpenPOWERFoundation/my_project.git
  1. 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

The project which control the look and feel of the document is the Docs-Maven-Plugin project.

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).