Bug 249543 - [ui] [doc] rework task doc and help contexts to fit new workflows
Summary: [ui] [doc] rework task doc and help contexts to fit new workflows
Status: VERIFIED FIXED
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: p2 (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.5 RC4   Edit
Assignee: Susan McCourt CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
: 268392 (view as bug list)
Depends on:
Blocks:
 
Reported: 2008-10-02 16:43 EDT by Susan McCourt CLA
Modified: 2009-06-03 12:45 EDT (History)
3 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 2008-10-02 16:43:43 EDT
In bug 236740, the available and installed software views are moving around.  

In the long run, we are also trying to make it possible for clients to tweak the p2 UI by moving around components (available list, installed list, history list, repo list) wherever they see fit.  For example, the available list could be in a special dialog, a wizard, a view, etc.  Likewise the repo list could be in the wizard, a preference page, etc.

This also suggests rewording the tasks doc to not refer to how the user got there.  For example, tasks-121.htm describes the different modes of the available software view, but it also talks about choosing Help>Software Updates... to get there.  Instead, it should focus on how the available software can be viewed.  Another task topic might focus on the surrounding buttons - what actions are available.
Comment 1 Susan McCourt CLA 2009-04-15 18:50:32 EDT
marking RC1 as there may be code changes (context ids) to get in early before the doc is actually written.
Comment 2 Susan McCourt CLA 2009-04-15 19:07:37 EDT
*** Bug 268392 has been marked as a duplicate of this bug. ***
Comment 3 Susan McCourt CLA 2009-04-30 01:23:14 EDT
looking at my RC1 list...this can wait til later.
Comment 4 Susan McCourt CLA 2009-05-13 12:51:22 EDT
moving back to RC2.  Although this is a doc bug, there are very likely to be code changes to set the proper help context id's on the new dialogs.
Comment 5 Chris Goldthorpe CLA 2009-05-13 12:56:13 EDT
Shouldn't that be 3.5RC2, not 3.4RC2
Comment 6 Susan McCourt CLA 2009-05-13 13:28:40 EDT
(In reply to comment #5)
> Shouldn't that be 3.5RC2, not 3.4RC2
> 

thanks!  I would have ripped my hair out for at least a few minutes trying to find this bug later...
Comment 7 Susan McCourt CLA 2009-05-21 16:31:58 EDT
I verified that all of the pages still link to the correct context help id's.

Install/Update prefs
Automatic Update prefs
Available Software Sites prefs
Installed Software page*
Installation History page*
Install wizard selection, details, and license page
Update wizard selection, details, and license page
Uninstall wizard selection, details, and update page
Add repository dialog

*The pages in the about dialog have to have focus (vs. the page tab) to see the specific help.  This threw me off at first.

I was considering changing the code so that the first page of the install new software wizard used the IProvHelpContextIds.AVAILABLE_SOFTWARE context instead of the generic install wizard context, but that context was not yet defined anyway.  

So it makes more sense to simply update the INSTALL_WIZARD context to include information about the new first page.

Note to self: have to figure out how to document the repo selection part of that page when in some products it won't be there...

Bottom line:  no code changes for RC2, moving to RC4 since this is purely documentation at this point
Comment 8 Susan McCourt CLA 2009-06-02 17:58:05 EDT
I've updated the tasks for the 3.5 workflows.
The biggest change was merging two previously separate tasks:  "Browsing for available software" and "using the install wizard."

I also renamed a few of the pages and fixed all the refs.

Also searched on all mention of "Updates" in the user doc and corrected the few that were left.

There was one file I wasn't sure about.
concepts-25.htm discusses features and links to the old update manager tasks.  Should we be linking instead to the install and update tasks?  The reason I ask is that we don't really talk about "features" per se in any of the p2 doc, so it's a bit odd.  However I don't see that we would keep linking to the update manager doc.

John, what do you think?
Comment 9 John Arthorne CLA 2009-06-02 18:58:00 EDT
> John, what do you think?

I think it should point to the new tasks topics rather than the old UM topics. I have done this and released to HEAD.
Comment 10 Susan McCourt CLA 2009-06-02 19:10:54 EDT
thanks, John.
marking this bug as fixed since the initial reorg/rewrite is done.  I'll verify this bug in tomorrow's build by testing all of the contexts and rereading the doc.
Comment 11 John Arthorne CLA 2009-06-03 10:00:43 EDT
Susan, one thing I noticed while re-reading today is that one page (tasks-127.htm) uses the term "update site", while everywhere else you seem to use "software site". Unless this was intentional, I suggest we consistently use "software site".
Comment 12 Susan McCourt CLA 2009-06-03 12:45:00 EDT
(In reply to comment #11)
> Susan, one thing I noticed while re-reading today is that one page
> (tasks-127.htm) uses the term "update site", while everywhere else you seem to
> use "software site". Unless this was intentional, I suggest we consistently use
> "software site".
> 

I agree.  Fixed in HEAD.  I also fixed some inconsistent terminology in the contexts.