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

Bug 534073

Summary: [Tips] Create JSon based Tip Provider for JDT
Product: [Eclipse Project] Platform Reporter: Wim Jongman <wim.jongman>
Component: User AssistanceAssignee: Platform-UI-Inbox <Platform-UI-Inbox>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: daniel_megert, mistria
Version: 4.8   
Target Milestone: ---   
Hardware: PC   
OS: Windows 10   
See Also: https://git.eclipse.org/r/121815
https://git.eclipse.org/c/platform/eclipse.platform.ua.git/commit/?id=1889866f88b32b8cb1bd266cdc5859429ca230b4
https://git.eclipse.org/r/121904
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=165518096041601df2ac603281504e6b479927fd
https://git.eclipse.org/r/121905
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=fb345a81200f2cb7021cdb0d44c1d36d17de3e4b
https://git.eclipse.org/r/121906
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=c7db7152c8d970785efa1381691b3eef23ebce71
https://git.eclipse.org/r/121907
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=8e77683b36092aab7dc15fef245c84f77b18edf0
https://git.eclipse.org/r/121908
https://git.eclipse.org/r/121913
https://git.eclipse.org/r/121914
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=38dcd21fe5e64c79eea67d86ecb2b624e6d74683
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=962d921a35471876bf2711902d268aca527f984a
https://git.eclipse.org/c/platform/eclipse.platform.ua.git/commit/?id=0042755f51c37aa19cf5f0cfea5259ef71437683
https://git.eclipse.org/r/121945
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=dee48561896e7d5b805aff2eec184bea9718b10c
https://git.eclipse.org/r/121953
https://git.eclipse.org/r/121954
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=830eb3dca4095f0c7c3cb58ecc91cff10bc4c3fb
https://git.eclipse.org/r/122354
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=e9730f84082fac7af44e9d6e2b19dd696a2c87c5
https://git.eclipse.org/r/122441
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=9dff3286ac3fc7a38e16b160d91e459ce61e6203
https://git.eclipse.org/r/122489
https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=a55daf01ce26bb8ed81fcba845720d7819f0e150
Whiteboard:
Bug Depends on: 534178    
Bug Blocks: 531784    
Attachments:
Description Flags
HTML Errors none

Description Wim Jongman CLA 2018-04-26 03:32:27 EDT
Creates a provider based on Json serving  tips for Platform and related projects (e.g. PDE, JDT, etc..)
Comment 1 Eclipse Genie CLA 2018-04-26 15:51:56 EDT
New Gerrit change created: https://git.eclipse.org/r/121815
Comment 3 Eclipse Genie CLA 2018-04-28 05:06:23 EDT
New Gerrit change created: https://git.eclipse.org/r/121904
Comment 5 Eclipse Genie CLA 2018-04-28 05:35:55 EDT
New Gerrit change created: https://git.eclipse.org/r/121905
Comment 7 Eclipse Genie CLA 2018-04-28 05:54:56 EDT
New Gerrit change created: https://git.eclipse.org/r/121906
Comment 9 Eclipse Genie CLA 2018-04-28 06:10:56 EDT
New Gerrit change created: https://git.eclipse.org/r/121907
Comment 11 Eclipse Genie CLA 2018-04-28 06:20:26 EDT
New Gerrit change created: https://git.eclipse.org/r/121908
Comment 12 Eclipse Genie CLA 2018-04-29 15:27:54 EDT
New Gerrit change created: https://git.eclipse.org/r/121913
Comment 13 Eclipse Genie CLA 2018-04-29 15:36:09 EDT
New Gerrit change created: https://git.eclipse.org/r/121914
Comment 14 Mickael Istria CLA 2018-04-29 16:18:57 EDT
Would it be possible to have the tips inside the related *.doc.user bundles?

I see many patches were merged without leaving much opportunity for review. In general, it's better to not rush into committing such new content and  try to get some feedback before merging it. Note that it's not too important in that case because even if we change it, it doesn't break an API nor change behavior.
Comment 17 Wim Jongman CLA 2018-04-29 16:45:21 EDT
(In reply to comment #14)
> Would it be possible to have the tips inside the related *.doc.user bundles?

Would that not be included in the IDE?

> 
> I see many patches were merged without leaving much opportunity for review. In
> general, it's better to not rush into committing such new content and  try to
> get some feedback before merging it. Note that it's not too important in that
> case because even if we change it, it doesn't break an API nor change behavior.

Indeed, it is not breaking anything. These are Sopot's tips converted to good looking content. I did not expect someone would want to review this.
Comment 19 Mickael Istria CLA 2018-04-29 16:54:44 EDT
(In reply to Wim Jongman from comment #17)
> Would that not be included in the IDE?

The provider.json files would be, but I don't think it's what we're discussing when we say "include in IDE or not". What matters is more about whether we include the tips framework in and the dialog by default, but an extra-file in one bundle isn't a too bad thing even if it's not read by default.
But I think it's more the topic of bug 534178 so let's keep discussing there.

> Indeed, it is not breaking anything. These are Sopot's tips converted to
> good looking content. I did not expect someone would want to review this.

What we need to review is the whole process of how tips get integrated in the IDE, where they're located, where they're published...
I believe this bug actually depends in bug 534178 and a consensual decision of where to store and deploy the tips before starting to actually add tips to the IDE.
Comment 20 Eclipse Genie CLA 2018-04-30 13:49:42 EDT
New Gerrit change created: https://git.eclipse.org/r/121945
Comment 22 Wim Jongman CLA 2018-04-30 13:54:40 EDT
Tip content moved to their respective *.doc.user/tipOfTheDay locations
Comment 23 Mickael Istria CLA 2018-04-30 14:14:29 EDT
(In reply to Eclipse Genie from comment #21)
> Gerrit change https://git.eclipse.org/r/121945 was merged to [master].
> Commit:
> http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/
> ?id=dee48561896e7d5b805aff2eec184bea9718b10c

(In reply to Wim Jongman from comment #22)
> Tip content moved to their respective *.doc.user/tipOfTheDay locations

Please leave a bit more time for reviews and to allow feedback ;)

I didn't realize all the big files involved in the existing tips and I'm now wondering whether the user.doc bundles are the best fit for those. Also, as long as the files are not in build.properties, it means they're basically ignored at build time while they will cause new qualifier for same output.
After all, as I see this change, it seems to me that dedicated bundles would be better...
Comment 24 Eclipse Genie CLA 2018-04-30 16:16:04 EDT
New Gerrit change created: https://git.eclipse.org/r/121953
Comment 25 Wim Jongman CLA 2018-04-30 16:16:51 EDT
JDT Tip provider was submitted to platform. Please take a look. I wonder how to get build by the way..
Comment 26 Eclipse Genie CLA 2018-04-30 16:19:19 EDT
New Gerrit change created: https://git.eclipse.org/r/121954
Comment 28 Dani Megert CLA 2018-05-02 12:41:39 EDT
Created attachment 273884 [details]
HTML Errors

Please take a look at those errors.
Comment 29 Dani Megert CLA 2018-05-08 15:29:27 EDT
(In reply to Dani Megert from comment #28)
> Created attachment 273884 [details]
> HTML Errors
> 
> Please take a look at those errors.

Those are still there.
Comment 30 Eclipse Genie CLA 2018-05-09 09:35:52 EDT
New Gerrit change created: https://git.eclipse.org/r/122354
Comment 32 Eclipse Genie CLA 2018-05-10 15:52:22 EDT
New Gerrit change created: https://git.eclipse.org/r/122441
Comment 34 Eclipse Genie CLA 2018-05-11 13:48:48 EDT
New Gerrit change created: https://git.eclipse.org/r/122489