42 Commits (4208a0052e86259a8fbac927e026a62920039375)
 

Author SHA1 Message Date
Jeff Scheel 4208a0052e Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template 6 years ago
Jeff Scheel bea197bca4 Miscellaneous updates.
For Doc Devel Guide:
- Clarify first build documentation
- Add documententation how to publish
- AWT exception workaround for users
- Clarify which document tags need updating for new docs
- Expand description of how to get started
- Minor updates to reference to document directory from "template/" to "doc_dev_guide/"

For project:
- Add new document template (doc_template) for creating new specifications
- Add new document template for create errata (WG Notes)
- Rename the template/ directory to doc_devel_guide/
- Update README for new content and contact people

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
6 years ago
Jeff Scheel 387a460439 Formatting update
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel c6043ebcc4 Slight reformatting of video introduction
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 13223705ef Add pointer to Doc Dev video
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
jeffdbrown 5116ba04dd version 1.2 - JDB:
- added examples for background color in tables
    - added examples for variablelists

Signed-off-by:  Jeff Brown <jeffdb@us.ibm.com>
7 years ago
Jeff Scheel b74af890cf Multiple updates as follows:
- Start 1.2 release (_pre1)
- Add subsection in Getting Started to include first build
- Add subsection in OpenPOWER Documentation Process on document packaging

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 0751965d7f Second pass at supporting RST->DB conversions:
- Minor update to rst_template/bk_main.xml to use namespace reference
  "xl" instead of "xlink" to be compatible with herold output
- Create new opf_html2db.py script to convert singlehtml output of projects
  using herold and then massage into OPF format for inclusion in rst_template
  format

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 51954d8265 Updates public document pointer and contribution section to point to mailing list
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 2810b0640a Updates to add community information such as mailing list
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel ed8ad76ef7 Updates to RST to Docbook conversion process to minimize Makefile impact
- Cleanup of revision history code (opf_docbook.py)
- Pull in GitHub clones and post build cleanups from Makefile (opf_docbook.py)
- Also drive Maven build with "tee" of output (opf_docbook.py)
- Add better status messages during build (opf_docbook.py)

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel bacd4fad3a Correct directory to relative value for opf_docbook.py
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel b1301a3f1e Shorten git log records to only those for doc/ directory in opf_docbook.py
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel c980a58802 Correct date formatting in opf_docbook.py in revhistory.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel e08f7b8128 Fix path to bk_main.xml in opf_docbook.py
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel e92c2cfe8d Correct opf_docbook.py bug
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 3eefb43967 Add support for retrieving Git Log history as revision history in RST.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel c022c95f88 Add preliminary director rst_template for rst support
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 95a8d02310 Update to 1.1.0 level per Work Group Approval to publish.
Signed-off by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel ad1ee97ba9 Miscellaneous updates:
- Open 1.1 version (_pre3)
- Document how to reference symbols by value.
- Describe extension to exploit extended symbols.
- Add sub-list examples.
- Describe extension for changing font-size in text.

Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 9ebc0a7e0c Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template 8 years ago
Jeff Scheel 284b440273 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 5ec5484e6a 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 09e55d50db 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 7e57f86263 Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template 8 years ago
Jeff Scheel 20c6ca533f Minor updates to document name.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 8a606f02a7 Update README.md
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 years ago
Jeff Scheel 3b09cf140b 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 021158ca3b 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 f6f74b133b 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 7920ff7974 Correct build error: move copyright after xml invocation
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
9 years ago
Jeff Scheel 2843b3425c 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 51a32f3077 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 1ba6581021 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 8906b605e6 Update README.md
- Corrected formatting of nested code in bulleted list.
- Corrected wording to explicitly reference Docs-Template project
9 years ago
Jeff Scheel 73e44150bf 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 27a027d53c Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template
signed off by: Jeff Scheel <scheel@us.ibm.com>
9 years ago
Jeff Scheel 3da73be554 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 2269263f00 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 bd86323a76 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 7f09435f1e 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