Bug 491523 - Add a 'Tips and Tricks' to the Welcome page
Summary: Add a 'Tips and Tricks' to the Welcome page
Status: ASSIGNED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 4.6   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Platform-UI-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2016-04-12 12:12 EDT by Dani Megert CLA
Modified: 2019-04-12 22:35 EDT (History)
6 users (show)

See Also:


Attachments
Picture showing missing Tips and Tricks (62.78 KB, image/png)
2016-05-17 10:31 EDT, Dani Megert CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Dani Megert CLA 2016-04-12 12:12:09 EDT
Add a 'Tips and Tricks' link to the Welcome page.

At first this would just invoke Help > Tips and Tricks...

Ideally, we would create one HTML document with all tips and tricks on the fly (bug 491522).
Comment 1 Dani Megert CLA 2016-04-12 12:12:53 EDT
Brian, something for you?
Comment 2 Brian de Alwis CLA 2016-04-12 14:21:52 EDT
Sure.  That's the 'org.eclipse.ui.help.tipsAndTricksAction' command id.
Comment 3 Lars Vogel CLA 2016-05-12 05:17:04 EDT
Brian, is this still planned for 4.6?
Comment 4 Brian de Alwis CLA 2016-05-12 11:16:43 EDT
Yes.  Patch to come for RC2.  It'll just be for the default quicklinks, shown if nothing has been configured.  It doesn't make sense to put this in with the Neon packages until the Tips & Tricks is replaced (bug 491522) as the current is pretty lousy.
Comment 5 Dani Megert CLA 2016-05-12 11:33:46 EDT
(In reply to Brian de Alwis from comment #4)
> Yes.  Patch to come for RC2.  It'll just be for the default quicklinks,
> shown if nothing has been configured. 

Not sure what you mean here.


> It doesn't make sense to put this in
> with the Neon packages until the Tips & Tricks is replaced (bug 491522) as
> the current is pretty lousy.

We could have a Tips and Tricks page that has the entries of the Tips and Tricks dialog as links. This would make sure that Tips and Tricks from everyone are shown.
Comment 6 Eclipse Genie CLA 2016-05-12 11:47:19 EDT
New Gerrit change created: https://git.eclipse.org/r/72641
Comment 7 Brian de Alwis CLA 2016-05-12 11:51:28 EDT
(In reply to Dani Megert from comment #5)
> Not sure what you mean here.

I've added the 'org.eclipse.ui.help.tipsAndTricksAction' command to the default quicklinks. But this is only shown when there are no other definitions found.


The Platform and SDK products currently don't show the Quicklinks as they're using the 'root' page as their start and home pages.  Only the EPP packages (that have opted into the Solstice) are using the new 'qroot' page.  And they're defining their own quicklinks.

This was useful exercise though as the Tips and Tricks action is only installed if there are features carrying Tips and Tricks information, and revealed that the QuicklinksViewer needs to filter commands that are actually enabled.
Comment 8 Dani Megert CLA 2016-05-16 05:07:41 EDT
(In reply to Brian de Alwis from comment #7)
> (In reply to Dani Megert from comment #5)
> > Not sure what you mean here.
> 
> I've added the 'org.eclipse.ui.help.tipsAndTricksAction' command to the
> default quicklinks. But this is only shown when there are no other
> definitions found.
> 
> 
> The Platform and SDK products currently don't show the Quicklinks as they're
> using the 'root' page as their start and home pages.  Only the EPP packages
> (that have opted into the Solstice) are using the new 'qroot' page.  And
> they're defining their own quicklinks.

As for this bug report I was rather expecting another entry on our main/root page.


Can you provide a Gerrit change (not to be released) that allows me to see that the fix works with just the SDK?
Comment 9 Eclipse Genie CLA 2016-05-16 09:19:37 EDT
New Gerrit change created: https://git.eclipse.org/r/72814
Comment 10 Brian de Alwis CLA 2016-05-16 09:25:03 EDT
(In reply to Dani Megert from comment #8)
> As for this bug report I was rather expecting another entry on our main/root
> page.

The root page only shows the top-level pages and isn't really intended to be extended.  There isn't a simple way to add anything without changing the themes.

I've put up a patch for the org.eclipse.sdk.ide product that uses the 'qroot' page for the starting page:

   https://git.eclipse.org/r/72814
Comment 11 Dani Megert CLA 2016-05-16 10:03:21 EDT
(In reply to Brian de Alwis from comment #10)
> (In reply to Dani Megert from comment #8)
> > As for this bug report I was rather expecting another entry on our main/root
> > page.
> 
> The root page only shows the top-level pages and isn't really intended to be
> extended.

Add another top-level page?
Comment 12 Brian de Alwis CLA 2016-05-16 11:07:22 EDT
(In reply to Dani Megert from comment #11)
> Add another top-level page?

That's 'qroot' ;)  We could consider using qroot for the org.eclipse.sdk.ide product along the lines of this Gerrit patch (https://git.eclipse.org/r/72814, though we need to also set HOME_PAGE too).  I don't think we should change the default for the org.eclipse.platform.ide product.
Comment 13 Dani Megert CLA 2016-05-17 10:27:43 EDT
(In reply to Dani Megert from comment #11)
> (In reply to Brian de Alwis from comment #10)
> > (In reply to Dani Megert from comment #8)
> > > As for this bug report I was rather expecting another entry on our main/root
> > > page.
> > 
> > The root page only shows the top-level pages and isn't really intended to be
> > extended.
> 
> Add another top-level page?

Sorry, I meant like Tutorial or Samples.
Comment 14 Dani Megert CLA 2016-05-17 10:31:36 EDT
Created attachment 261799 [details]
Picture showing missing Tips and Tricks

(In reply to Eclipse Genie from comment #6)
> New Gerrit change created: https://git.eclipse.org/r/72641

This does not work for me. I've read this in the change:

> - Add Tips and Tricks action to the default quicklinks, shown when no 
> other quicklinks are defined. 

So, this will most likely never work? At least when testing, I did not get the Tips and Tricks, even though some are installed (see attached picture).
Comment 15 Brian de Alwis CLA 2016-05-17 14:30:53 EDT
(In reply to Dani Megert from comment #13)
> Sorry, I meant like Tutorial or Samples.

That makes sense and sounds worthy.  Unfortunately that's also more work, and it won't be done for RC2.  I'll think if there's a low-impact way to turn T&T content into a populable content for RC3.
Comment 16 Dani Megert CLA 2016-05-18 03:39:39 EDT
Please add reviewers again once you have something for RC3. Please also keep the stricter ruler for RC3 in mind. For details see https://www.eclipse.org/eclipse/development/plans/freeze_plan_4_6.php#FixPassAfterRC2
Comment 17 Brian de Alwis CLA 2016-05-20 23:11:58 EDT
Haven't been able to come up with a low-impact approach.  Moving to later.
Comment 18 Dani Megert CLA 2019-01-16 10:20:11 EST
This is still desired to have.