Bug 277388 - [About] [doc] update the about user doc for any changes in workflow
Summary: [About] [doc] update the about user doc for any changes in workflow
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.5   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.5 RC4   Edit
Assignee: Susan McCourt CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2009-05-21 15:53 EDT by Susan McCourt CLA
Modified: 2009-06-04 17:50 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Susan McCourt CLA 2009-05-21 15:53:06 EDT
Need to check the context help for the plug-in details, feature details, and configuration details context help and task doc.  Update screen shots if needed.

I also noticed that the context help id for the system summary page is wrong.  In IWorkbenchHelpContextIds it is "system_summary_editor_context" but in the doc itself it is "system_summary_dialog_context".

(I think the dialog_context name is better, actually, but at this point in the release should likely change it on the doc side.).
Comment 1 Susan McCourt CLA 2009-06-02 18:13:01 EDT
> 
> I also noticed that the context help id for the system summary page is wrong. 
> In IWorkbenchHelpContextIds it is "system_summary_editor_context" but in the
> doc itself it is "system_summary_dialog_context".
> 
> (I think the dialog_context name is better, actually, but at this point in the
> release should likely change it on the doc side.).
> 

Fixed this part in HEAD for 20090602-2000.
I said it wrong in the previous comment.  The context name in the IWorkbenchHelpContextIds was "system_summary_dialog_context."  (not editor).  The help contextsWorkbench.xml was using system_summary_editor_context and I changed this to match the code.
Comment 2 Susan McCourt CLA 2009-06-03 14:07:45 EDT
There wasn't much to "fix" because the contexts for each individual about page had no links to actual topics.

I added task topics for
Installation Details
Installation Detail for Plug-ins
Installation Detail for Features
Installation Detail for the Configuration

These task topics are now referenced by the contexts for each about page.
The overall installation details task topic is now referenced by the context for the help>about action as well as the dialog.

In the table of contents, these new topics are actually referenced in the p2 section of the doc.

Note that we don't really have symmetry in that we don't provide task topics called
"Installed Software" or "Installation History".
The help contexts for the about pages contributed by p2 are a bit more task-oriented, in that they refer to what you might want to do from these pages (update, install, revert).  I think this is ok since there's more to do on these pages than the platform about pages, which are really just about browsing the detail.

I also added links to these new pages from the p2 pages where appropriate.

Marking fixed.  I'll reread and verify after tonight's build.
Comment 3 Susan McCourt CLA 2009-06-04 17:50:20 EDT
verified context links and content on WinXP, Build id: I20090603-2000