- Technical updates to reflect new project structure.
- Addition of project structure section to explain project relationships.
- General readability improvements.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
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>
Starting major update of documentation technical content, but need
to rework tree structure. Therefore, pushing up existing changes.
They are not intented to be complete nor accurate yet. More to come.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
Three minor updates:
- Return the plugin and repository pointer to public URL.
- Comment out the template document versioning to enable auto-updates to latest level.
- Add a "TODO:" flag for new documents to allow for building of all documents from docs directory.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
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>