Bugzilla – Full Text Bug Listing
| Summary: | restructure the User Guide and FAQ | ||||||
|---|---|---|---|---|---|---|---|
| Product: | z_Archived | Reporter: | Mik Kersten <mik.kersten> | ||||
| Component: | Mylyn | Assignee: | Wesley Coelho <wes.coelho> | ||||
| Status: | RESOLVED FIXED | QA Contact: | |||||
| Severity: | enhancement | ||||||
| Priority: | P2 | CC: | hiroyuki.inaba, robert.elves, steffen.pingel, wes.coelho | ||||
| Version: | unspecified | ||||||
| Target Milestone: | 3.1 | ||||||
| Hardware: | All | ||||||
| OS: | All | ||||||
| Whiteboard: | |||||||
| Bug Depends on: | 260212, 260213 | ||||||
| Bug Blocks: | |||||||
| Attachments: |
|
||||||
|
Description
Mik Kersten
From bug 243962: The user guide in the Eclipse Wiki needs to be reviewed and updated in order to generate Eclipse Help contents (bug 242979). Link to the user guide: http://wiki.eclipse.org/index.php/Mylyn_User_Guide *** Bug 243962 has been marked as a duplicate of this bug. *** From our latest chat, we should consider turning the User Guide into a User Reference or Feature Reference in order to make it clear that it does not contain tutorial content. Steffen: Please take a pass over the Community page(s). Created attachment 113525 [details]
mylyn/context/zip
Done. Please review my changes. Based on meetings and discussions, here's how I think we should revive the User Guide and FAQ, which has seen almost no community contributions for some time. First, we change it into something that we can justify maintaining, which I think is more a user reference than tutorial material. We remove all content that's stale, and make sure that we update it with every release (e.g., anything that shows up in the New & Noteworthy gets a corresponding entry in the User Reference). Here's what I think we should do with each section: * Introduction: can revise again when everything else is done, but I took a cut at it and it should be fine. * Installation: Move to FAQ. Update, remove stale content, structure can stay mostly as-is, add step-by-step P2 instructions, link from Download page. * Configuration: Best practices type stuff should be moved out. Things like Key Mappings and System Properties need to stay. User Guide will contain the following sections, and each will contribute to Dynamic Help. * Task List view * Task Repositories view * Task Editor * New Task wizard * New Query wizard * Preference Pages (one subsection for each) * Task-Focused Interface (would be nice to contribute an entry to all Navigator and Marker views) * Change Set Management (contribute entry to Synchronize view) (In reply to comment #8) > Here's what I think we should do with each section: > * Introduction: can revise again when everything else is done, but I took a cut > at it and it should be fine. > * Installation: Move to FAQ. Update, remove stale content, structure can stay > mostly as-is, add step-by-step P2 instructions, link from Download page. > * Configuration: Best practices type stuff should be moved out. Things like Key > Mappings and System Properties need to stay. This portion done. I've revised and updated the wiki content so that it covers the topics listed in comment #8 (Sections 3 through 10). I have renamed the User Guide to Reference and updated the contents in the help plug-in. Thanks a lot for updating the contents Wesley! It's look much better and is actually current now. Reassigning... Marking resolved. *** Bug 260375 has been marked as a duplicate of this bug. *** |