Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "COSMOS Documentation Meeting Minutes 20080905"
(New page: These are the minutes for the Documentation meeting on 5 September 2008. === Attendees === * Paul (minutes) * Jack * Adriane * Pam * David * Jason * Jeff * Jimmy === Agenda === We nee...) |
(→Discussion) |
||
Line 18: | Line 18: | ||
=== Discussion === | === Discussion === | ||
+ | |||
+ | ==== Doc Overview ==== | ||
+ | |||
+ | Doc originally put together by IBM tech pub resource using DITA. From DITA source generated both HTML and PDF formats. However as proprietory tools required to edit DITA source this has been abandoned in favor of editing HTML directly for doc updates. | ||
+ | |||
+ | Three documents are planned for the 1.0 release. | ||
+ | |||
+ | * Installation Guide | ||
+ | * Users Guide | ||
+ | * Development Guide | ||
+ | |||
+ | The HTML source is stored in CVS and can be viewed using CVS web interface [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.cosmos/doc/vi12/?root=Technology_Project&sortby=log COSMOS 1.0 documentation] |
Revision as of 10:39, 8 September 2008
These are the minutes for the Documentation meeting on 5 September 2008.
Contents
Attendees
- Paul (minutes)
- Jack
- Adriane
- Pam
- David
- Jason
- Jeff
- Jimmy
Agenda
We need to discuss the remaining items in the documentation and decidewhat sections need to be updated, which ones that are empty need to have something written in them, and which ones are non-critical and should just be removed. Then each section should be assigned to someone to complete for i14. Completing the section means making all additions and updates to the HTML files in cvs and ensuring the formatting works. Changing sections in the SML chapter of User Guide and chapter2 of the Dev Guide will require also updating the help plugins for those sections in addition to the main HTML.
Discussion
Doc Overview
Doc originally put together by IBM tech pub resource using DITA. From DITA source generated both HTML and PDF formats. However as proprietory tools required to edit DITA source this has been abandoned in favor of editing HTML directly for doc updates.
Three documents are planned for the 1.0 release.
- Installation Guide
- Users Guide
- Development Guide
The HTML source is stored in CVS and can be viewed using CVS web interface COSMOS 1.0 documentation