57 Commits (1d1dd51b04dd610591e7fa9f0c1787f7d5b71387)
 

Author SHA1 Message Date
Yong Lu 1d1dd51b04 add tag and readme
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
4 years ago
Yong Lu d45698a1b7 Revision 1.0_pre3
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu 241b859ee9 Edits for review suggestions
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu 613bbce872 Change state to review draft and update mailling list
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu 4a6bcf94a1 Remove pictures not-in-use, modify Specification to Not
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Jeff Scheel 90c265fcfb Update title
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
5 years ago
Jeff Scheel f3e786ccf9 Update README to reflect new projeect. More work needed.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
5 years ago
Jeff Scheel dd13c69b60 Project directory cleanup
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
5 years ago
Yong Lu 31098d13b3 add the VSEC address information
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu c463e6060c Pick up the new written capi20_snap chapter
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu 47113bc783 Adjust the order and remove CAPI1.0 content
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu 1a33a09ef1 Add chapter 2.4
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu 6a91f6f31e Also add the diagram source files
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Yong Lu 6e1454b600 Add Document enable_capi_snap
Signed-off-by: Yong Lu <luyong@cn.ibm.com>
5 years ago
Jeff Scheel f4fbacf7f4 Final updates to release 1.2 version
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
6 years ago
Jeff Scheel 6a55415b92 Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template 6 years ago
Jeff Scheel b8e39d5d14 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 41ed7c9d1e
Formatting update
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
6 years ago
Jeff Scheel 5913f4d0f7
Slight reformatting of video introduction
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
6 years ago
Jeff Scheel 00d2c44acf
Add pointer to Doc Dev video
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
6 years ago
jeffdbrown 463afd9c5e version 1.2 - JDB:
- added examples for background color in tables
    - added examples for variablelists

Signed-off-by:  Jeff Brown <jeffdb@us.ibm.com>
6 years ago
Jeff Scheel 9600462da2 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>
6 years ago
Jeff Scheel 1d1abf3305 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 9b177dc647 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 f99fc5932f Updates to add community information such as mailing list
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 22899adcd3 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>
7 years ago
Jeff Scheel ef3ebe5cff Correct directory to relative value for opf_docbook.py
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel a31a3f69e9 Shorten git log records to only those for doc/ directory in opf_docbook.py
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 6417c76a6f Correct date formatting in opf_docbook.py in revhistory.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 26ff4aa29e Fix path to bk_main.xml in opf_docbook.py
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel ff6fdb1a71 Correct opf_docbook.py bug
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel d7cd0d6690 Add support for retrieving Git Log history as revision history in RST.
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 13eb33c8d4 Add preliminary director rst_template for rst support
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel ae3d6a294a Update to 1.1.0 level per Work Group Approval to publish.
Signed-off by: Jeff Scheel <scheel@us.ibm.com>
7 years ago
Jeff Scheel 5d563413ee 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>
7 years ago
Jeff Scheel d66f7396d4 Merge branch 'master' of https://github.com/OpenPOWERFoundation/Docs-Template 7 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>
7 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>
8 years ago
Jeff Scheel 7a10d22137 Correct build error: move copyright after xml invocation
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
8 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>
8 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>
8 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>
8 years ago
Jeff Scheel ec005f1a93 Update README.md
- Corrected formatting of nested code in bulleted list.
- Corrected wording to explicitly reference Docs-Template project
8 years ago