22 Commits (d66f7396d4c558a15f79406ce6b05c739c0007c8)
 

Author SHA1 Message Date
Jeff Scheel d66f7396d4 Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template 8 years ago
Jeff Scheel 1d02c4058e Miscellaneous updates:
- Open 1.1 version (_pre2)
- Add the mailing list to the abstract
- Add support for starting a new local project
- Add "git init" workaround to Troubleshooting for JAR dependency on git.
- Move "Understanding" section forward in document.
- Clarify "Workgroup POM" terminology.
- Further cleanup of "Master Template" naming change to "Document Development Guide".
- Additional explanation about publishing of documents, including flow charts
- Add recommendation of installation of Croscore fonts in new Install fonts section
- Include a policy on document versioning
- Add examples of special docbook extensions available in our tooling
- Increase the number of levels of sections in the TOC

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 1973ec940e Corred README.md title and intro paragraph
- Issue #1: Update to use new document title

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 014de307e5 Update reference to Maven Plug-in project
- Issue #4: Clarify that the project link is private so that people won't suspect a 
  broken link.  Provide directions on how to get access.

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 99d5b130e4 Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template 8 years ago
Jeff Scheel 922fe600c5 Minor updates to document name.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel fdd9d75445 Update README.md
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 7d7e4a318e Version 1.0.0 - Official release
- Remove draft markings
- Update version
- Make System SW Work Group the official owner of document

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 0322fd2f01 Version 0.9.5 - Minor updates
- Remove confidentiality, mark as public (Apache V2 license) in
  anticipation of approval by TSC.
- Issue 13: Adjusted template document versioning to be variable based, but
  still manually updates needed

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel d8e1d2fbdb New debugging sub-section, README update with license statement, version 0.9.4
- Bumped version to 0.9.4
- Added FO validation error debugging section with detailed steps
  in ch_template_debugging.xml.
- Provided links to sub-sections in top of Debugging section,
  again in ch_template.debugging.xml.
- Added License section with reference to Apache V2 license to README.md

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
9 years ago
Jeff Scheel 7a10d22137 Correct build error: move copyright after xml invocation
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
9 years ago
Jeff Scheel 3136f7755e System Software WG Review Updates, prep for TSC Review
- Updated Revision to 0.9.3 for working copy
- Convert to plugin version 1.3
- Added section on git commands
- Added section on OPF document process and reference appropriately
- Added links in Overview to main sections
- General document cleanup
- Convert graphics to SVG to improve clarity of scaled image
- Add DCO information to README.md file
- Add copyright and license statements to source files

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
9 years ago
Jeff Scheel 2bfe45a232 System Software WG Review Updates, prep for TSC Review
- Updated Revision to 0.9.3 for working copy
- Added Abstract text to describe document and provide common
  language for the role handling of the document in OPF
- Added section on git commands
- Added section on OPF document process and reference appropriately
- Added links in Overview to main sections
- General document cleanup
- Convert graphics to SVG to improve clarity of scaled image
- Add DCO information to README.md file

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
9 years ago
Jeff Scheel 5b46fd7bec Review version 0.9.2
- 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>
9 years ago
Jeff Scheel ec005f1a93 Update README.md
- Corrected formatting of nested code in bulleted list.
- Corrected wording to explicitly reference Docs-Template project
9 years ago
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
Jeff Scheel 3fc171872d Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template
signed off by: Jeff Scheel <scheel@us.ibm.com>
9 years ago
Jeff Scheel b19f342929 Interim doc push
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>
9 years ago
jeffdbrown 5273e5fbe3 Updated app_foundation.xml to use foundation doc public causeway urls.
Updated contact information to remove personal names and include generic foundation email addresses.

Signed-off-by:  Jeff Brown <jeffdb@us.ibm.com>
9 years ago
Jeff Scheel 558e0e898c Master POM updates
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>
9 years ago
Jeff Scheel dd9621910b 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>
9 years ago
Jeff Brown 45bc5cc263 Initial commit 9 years ago