GlassFish v3 Documentation Planning Minutes - 04/02/09 Main meetings page Attendees Ian, Dixie, Devika, Paul, June, Gail, Eric, Alan Agenda
- Review of AIs
- Progress on writing assignments by feature
- Bug status
- Open mic
- Next meeting
Meeting Notes 1. Review of AIs
-
- Paul:* Cross-check the v3 list of functional specifications against the list of features in the v2 documentation.
In progress. Paul is compiling a list of v2 features whose status with respect to v3 is uncertain. All: If you have anything to add to this page, do so by next Thurs 4/09. Paul will then follow-up with engineering.
- All* Send Paul the list of features you have questions about for EA (in or out?) and also v3 Final (in or out?). Or update the list of v2 features whose status with respect to v3 is uncertain.
In progress. All: Add updates to this page by next Thurs 4/09. Paul will then follow-up with engineering.
- June and Devika:* Discuss the possibility of combining all documentation about scripting into a single document and send details to Paul. In progress.
Other points of discussion:
- If you removed anything from this table add it back and add a comment instead of removing it (i.e., feature is covered by another spec, etc.). Going forward, don't remove anything from the table but instead add explanatory notes.
- Discussion about asant utility (not necessary; going away; no asant man page, etc.) and ant tasks (totally separate from asant; not going away). Not sure if ant is bundled with GlassFish any more or added through the Update Center. AI - Ian: Provide related info to June for Developers Guide.
- Discussion about EOL process for features marked NEVER. __AI - Paul: Verify EOL process for new features.
\
2. Progress on writing assignments by feature
- Went through the status page feature by feature.
- Lots of discussion, status, and updates. Best to listen to the recording for complete details:
- Dial 877.471.6587 or 402.970.2667
- Enter 1063899434069 as the program ID (Available until 05/02/09 at 11:59 PM CT)
- Press 7 to rewind 30 seconds, 8 to pause, and 9 to fast forward 30 seconds
Other points of discussion:
- Be sure to update the feature page as new information becomes available. Paul is sharing this with other teams. Good way to let stakeholders know where things stand and to make issues visible to a wider audience.
- CLI will be Paul's top priority once he finishes other work that's keeping him from working on GF v3 full time. This affects bundled docs and also has ramifications for our most visible docs such as the Admin Guide.
- The OLH work Kim has been doing is premature for EA. Should record this in a doc plan. Doc plans will probably have two phases/sections - describe the work that's required for EA and then add to it for RR.
- One of the main things writers and engineers use the Administration Reference book for is for finding dotted names. June will enhance the dotted names concepts man page to explain more about dotted names, what they are and how to find them (none of the concepts man pages have been fully developed). She will look at the get, set, and list man pages, decide what information should be moved, etc.
- Confusion about what books are going to be available for EA - small set or full set? Plan is to take the v3 Prelude doc set as a baseline and republish the whole thing with its new titles and part numbers in its new collection for EA. Even if some of those books in the set haven't actually changed since Prelude. The priorities are the bundled docs (OLH, man pages, QSG, html pages), installation guide, release notes, and sample descriptions - these are high priority and we should commit to doing those. Everything else is best effort for EA.
\
3. Bug status
- Standing item. We'll spend more time on this once writing begins in earnest and as we approach milestones.
- Keep on top of your bugs as you work on your docs.
\
4. Open mic
- Discussed the Administration Reference book. Do we need it (users should never touch domain.xml)? Can we change the title?
- Background: JES imposed uniformity of titles on all books, thus the name. AI - Paul: Doublecheck with doc lead on JES side and see if we're still bound by the rules that resulted in the title in the first place.
- If we can change the title, what should it be? Lots of suggestions, mostly for a name that's really geeky/boring/makes it clear you shouldn't touch domain.xml, including:
- XML schema reference
- domain.xml format reference
- file format reference
- domain file format reference
- all you've ever wanted to know about a file you should never touch =)
- Why not make this an appendix in the Admin Guide? People never look at that!
- Options: Make the information less appealing; put it into an appendix.
\
5. Next meeting
\
Thursday 04/09/09 2-3 PM PDT
\ Main meetings page
|
