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>
- 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>
- 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>
- 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>
- 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>
- 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>
- 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>
- 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>
- 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>
- 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>
- 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>
- 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>
@ -27,7 +27,7 @@ This can be accomplished with the following steps:
For more information about with the document generation, please refer to [Documentation Development Guide](https://openpowerfoundation.org/?resource_lib=openpower-foundation-documentation-development-guide)
The online version of this document can be found in the OpenPOWER Foundation
Document library at [https://openpowerfoundation.org/?resource_lib=enable-new-fpga-cards-for-capi-2-0](https://openpowerfoundation.org/?resource_lib=enable-new-fpga-cards-for-capi-2-0) and also this github repository's release tab.
Document library at [TBD](http://openpowerfoundation.org/?TBD) and also this github repository's release tab.
Yong Lu