COSMOSCommunityMeeting20080827

Att: Paul Saurabh Leonard Sheldon Srinivas David Jack

Are docs an exposure for COSMOS 1.0?

• installation guide. some changes. some formatting and additional information with regards to the Axis2 package. That's something that Hubert was finishing up.
• developer guide and user guide. there are empty paragraphs (headings with no content). haven't made a note of what they are.
• some sort of release notes to list known issues
• SML docs don't go very low level. high level API stuff. don't say that we support xml:base or whatever. David to look at it but from memory nothing should need to change.
• HTML & PDF versions have been submitted to CVS. We're supposed to be updating the HTML. They're the only ones we're going to update. Process for building those docs into something that's either going to be put on the wiki?
• we have two help plugins built by Rich. They are subsets of the user guide and developer guide. we have html guides that represent the entire user/developer guide. there are two copies of this guide. we have to update the information in two places.
• can the plug-ins be built from the HTML? that sounds like it could work. when they rebuilt the help files they added some anchors in there. not sure if they updated the big doc as well. to have contextual help from the SML tooling there has to be ?? in the tooling. wondering if when it's added also the full user guide so that as part of the build copy them in there.
• David to send Ruth an HTML file so that she can test hosting HTML on the server
• move the PDF and DITA in CVS to archive
• HTML is now the master copy
• Action:
  • 1. Host the HTML off of the "Documentation" tab on the http://www.eclipse.org/cosmos home page. This to be done by the build team.
  • 2. Build team to put a link on the COSMOS 1.0 Download page to zip files of the HTML content that is not included in the driver
  • 3. We will NOT send copies of the doc plug-ins to http://help.eclipse.org because they would be out of context.
  • 4. Paul and Hubert to make adjustments to the installation guide.
  • 5. Each project lead to ask their team to review the user guide and developer guide to find any gaps and recommend if we need to remove the blank headers or fill in information.
  • 6. Jack/Paul to investigate whether CA can have someone join part time to help with the docs. Someone to own the doc, not necessarily an information professional, but someone who can check to see that all of the parts are there.