Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 185836

Summary: [new uex] create universal intro content
Product: z_Archived Reporter: Mik Kersten <mik.kersten>
Component: MylynAssignee: Balazs Brinkus <balazs.brinkus>
Status: RESOLVED FIXED QA Contact:
Severity: enhancement    
Priority: P2 CC: wmitsuda
Version: unspecified   
Target Milestone: 2.0   
Hardware: All   
OS: All   
Whiteboard:
Bug Depends on:    
Bug Blocks: 359147    
Attachments:
Description Flags
universal intro patch
none
universal intro images
none
mylar/context/zip
none
manifest.mf contains o.e.webapp depencies
none
modified cheatsheets
none
mylar/context/zip none

Description Mik Kersten CLA 2007-05-07 15:14:24 EDT
This would be a bit help to people when they first install Mylar.

From: eclipse.org-planning-council-bounces@eclipse.org [mailto:eclipse.org-planning-council-bounces@eclipse.org] On Behalf Of Chris Goldthorpe
Sent: Monday, May 07, 2007 10:12 AM
To: eclipse.org-planning-council
Subject: [eclipse.org-planning-council] New Intro feature that Europa Components will find useful
...
I'd like to draw your attention to new functionality which we in the User Assistance team added in M7 which is of particular interest to Europa developers. This is solution to the perennial problem where a user installs a new feature but then doesn't know how to find the information which will help him get started using that feature. Here's the text from M7 New and Noteworthy: 

The first time Eclipse is restarted after installing plug-ins containing new Universal Intro content, the Welcome screen will open on a page which prominently shows the new content. In the example below a plug-in (created using the PDE Universal Intro template) was installed before Eclipse was restarted. 

We encourage teams to take advantage of this capability as a way of pointing the user at useful information about how to use their newly installed features/plugins/components.  Creating a plugin with universal intro content, or modifying and existing plugin is easy if you use the PDE template, instructions on how to do this are at http://www.eclipse.org/eclipse/platform-ua/documents/intro_3_3_features.html.
Comment 1 Mik Kersten CLA 2007-05-07 15:19:03 EDT
Balazs: what we will need first is a proposal for what should go on this page (it can be very simple to start) and then a patch for a contribution.  This should be the best bug to kick off your summer of code project started, so I'm marking it P2.
Comment 2 Balazs Brinkus CLA 2007-05-12 06:57:51 EDT
I think it over and I will make the proposal for tomorrow.
Comment 3 Balazs Brinkus CLA 2007-05-13 16:34:21 EDT
I thought it over and I made a list of the welcome page's items.


* Overview section:
  Title: Mylar
  Short description: Learn more about the Mylar task-focused ui
  Content: A simple, short description of mylar.


* Tutorials section:
  Group title: Mylar
  Tutorial title: Report an eclipse bug
  Tutorial Short description: Learn how to report a bug to Eclipse Bugzilla.
  Tutorial Content: A cheat sheet which uses the Help/Report bug function.

Later the tutorials section will be updated, as soon as the cheat sheets are 

finished.


* Samples section:
  I think this section could be empty.


* What's new section:
  Title: Mylar
  Short description: Find out about the significant changes made to Mylar
  Content: "New and noteworthy" from http://www.eclipse.org/mylar/doc/new.php.

If this list is proper, I will make a patch.
Comment 4 Mik Kersten CLA 2007-05-15 13:46:16 EDT
This sounds like a very good first pass Balazs.  I suggest that you make a patch which has *very* short overviews of the content, e.g. a sentence for each section.  Then commit that as a patch and we can come up with content on this bug.  

Agreed that the samples section should be empty for now.  

Regarding the New & Noteworthy, should we copy the content into org.eclipse.mylar.doc (we used to have it there) or can we just point to the web-based new & noteworthy?  Fyi the file is mylar/doc/new.html (see integrator ref for checking out the web site from CVS).

Regarding the tutorials, I think that the following two are key:

1) Getting started with Task Repositories.  Add a query to bugs.eclipse.org for all Mylar P1 and P2 enhancements.  This is one of the challenges of getting started, many users won't have a bug to submit, and once they have the repository set up it's quite straightforward to submit bugs.

2) Getting started with the Task-Focused UI.  This will show them how to activate a task, click the focus button, Alt+click, and switch tasks.
Comment 5 Balazs Brinkus CLA 2007-05-26 08:36:46 EDT
Created attachment 68854 [details]
universal intro patch
Comment 6 Balazs Brinkus CLA 2007-05-26 08:37:30 EDT
Created attachment 68856 [details]
universal intro images
Comment 7 Balazs Brinkus CLA 2007-05-26 08:40:40 EDT
I attached the patch file and the images in a zip file. 
Before the stable Mylar 2.0 comes out, I will update the new and noteworthy page and images.
Comment 8 Balazs Brinkus CLA 2007-05-26 20:14:09 EDT
Created attachment 68862 [details]
mylar/context/zip

I forgot to attach the context.
Comment 9 Mik Kersten CLA 2007-05-27 03:51:41 EDT
*** Bug 111865 has been marked as a duplicate of this bug. ***
Comment 10 Mik Kersten CLA 2007-05-27 04:02:42 EDT
Patch applied, great stuff Balazs!  Some comments:

1) Make the "Add Task Repository Step" sound optional before "Create a New Query", because we already automatically add the Eclipse.org repository.  However, it would be useful to have a step to prompt users to set the credentials for that repository (repository page now has a hyperlink for doing that).

2) It would help to simplify the "Use Task Focused UI" steps some.  First, do not suggest to switch to the PDE perspective because we try not to favor particular perspectives.  Open Task List view should be executable.  Then, instead of having the user create a new project, you could get them to activate a task and then do an "Open Type" on a Java type that they have in an existing project (or suggest creating a project if they don't).  Then the key thing to get them to do is to toggle the Focus button on the Package Explorer (you can probably make that executable too) and to get them to Alt+click when toggled (since it takes a while for users to learn this).  

Another thing I'm wondering is if we should really be redistributing the New & Noteworthy.  We used to do this, but the online documentation has been working better.  What do you think?
Comment 11 Balazs Brinkus CLA 2007-05-28 18:35:32 EDT
I will do the modifications.

We can use the online New & Noteworthy, but when I made the local page I followed the "general" eclipse style.
If we use the online version I would like to use it as a local version, in the help system. I wouldn't like to use a simple link which opens in a web browser.
If we choose the "general" version I can write a small shell script to make the rewriting faster.
Comment 12 Eugene Kuleshov CLA 2007-05-28 18:39:29 EDT
I've tried to open Overview page from Welcome view. I can see Mylar icon there, but when I click on it, new window pops up that shows the following error:

HTTP ERROR: 404
ProxyServlet: /help/index.jsp
RequestURI=/help/index.jsp

Powered by Jetty://

Comment 13 Balazs Brinkus CLA 2007-05-28 19:09:41 EDT
Created attachment 68980 [details]
manifest.mf contains o.e.webapp depencies

Sorry I forgot to add the org.eclipse.help.webapp to the plugin dependencies. You need o.e.help, o.e.help.ui, o.e.help.base, o.e.webapp and org.mortbay.jetty to use the help. Only the webapp isn't added automatically. 
I attach the modified manifest.mf file. I hope this will be working.
Comment 14 Balazs Brinkus CLA 2007-06-02 16:40:10 EDT
What is the decision about the "new and noteworthy" page? After the decision I can attach a new patch which contains the modifications.
Comment 15 Mik Kersten CLA 2007-06-05 12:51:08 EDT
Balazs: could you please make the changes to the manifest file a patch?

Regarding the New & Noteworthy, I'm fine with embedding it since it does make sense to link from Welcome.  We have a script for copying over the contents in /cvsroot/org.eclipse/www/mylar/build.xml so please update it to copy the contents in the way that you use them.
Comment 16 Balazs Brinkus CLA 2007-06-15 16:06:19 EDT
Mik: You wrote in the 10th comment, that Eclipse.org will be automatically added to the repository list. At the moment I can't see it in my list. Is the problem only with my system or it was removed from the list.
Comment 17 Mik Kersten CLA 2007-06-15 16:52:12 EDT
Might be that you have an old version, or that you don't have the full project set checked out (need mylyn.bugzilla.ide).  Run with a clean workspace to verify.
Comment 18 Balazs Brinkus CLA 2007-06-17 09:11:37 EDT
Created attachment 71562 [details]
modified cheatsheets

I made the modifications of the cheatsheets.
Comment 19 Balazs Brinkus CLA 2007-06-17 09:11:57 EDT
Created attachment 71563 [details]
mylar/context/zip
Comment 20 Mik Kersten CLA 2007-06-18 01:59:51 EDT
Patch applied.  Will do a full review of this towards the end of next week and file new bug reports if anything comes up.  Can we close this one now?

Great that this contribution will be in 2.0 Balazs!
Comment 21 Mik Kersten CLA 2007-06-21 11:55:44 EDT
Balazs: I made a new 48x48 image that uses the filter/fade metaphor instead of the deprecated "Mylar film" metaphor.  What do you think?
Comment 22 Mik Kersten CLA 2007-06-27 15:05:45 EDT
I think we're done here, and can continue improving the content as we go.  Great work Balazs.