Bug 548008 - Platform Help should use SVGs instead of pixel graphics
Summary: Platform Help should use SVGs instead of pixel graphics
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.12   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 4.13 M3   Edit
Assignee: Matthias Becker CLA
QA Contact:
URL:
Whiteboard:
Keywords: noteworthy
Depends on:
Blocks: 553304
  Show dependency tree
 
Reported: 2019-06-06 11:04 EDT by Matthias Becker CLA
Modified: 2019-11-21 05:04 EST (History)
4 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Matthias Becker CLA 2019-06-06 11:04:06 EDT 
4.13 follow up on Bug 546475
Comment 1 Matthias Becker CLA 2019-06-06 11:06:49 EDT 
This commit replaces some "diagram" like you see them on 
https://help.eclipse.org/2019-03/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2FgettingStarted%2Fintro%2Foverview.htm&cp=0_0

with SVGs. By doing this this diagrams no longer look ugly an pixelated but the browser will always render it super crisp in the correct resolution.

While drawing these SVGs I skipped the ugly drop-shadows (as they look so 90ies) and also use colors that look good both on light and dark background (as I want to adapt the help content in the future so that is respects dark mode).
Comment 3 Alexander Kurtakov CLA 2019-06-10 10:14:33 EDT 
Thanks Matthias.
Comment 4 Matthias Becker CLA 2019-06-14 05:29:29 EDT 
there are still PNG and GIF versions of icons used in the help
Comment 5 Eclipse Genie CLA 2019-06-14 05:30:04 EDT 
New Gerrit change created: https://git.eclipse.org/r/144032
Comment 6 Matthias Becker CLA 2019-06-14 05:34:32 EDT 
(In reply to Eclipse Genie from comment #5)
> New Gerrit change created: https://git.eclipse.org/r/144032

This is the next round of PNGs and GIF I replaces with SVGs so they are sharp and crisp.

There are still some icons to be replaces they will follow later in additional gerrit(s)
Comment 8 Eclipse Genie CLA 2019-06-14 10:18:57 EDT 
New Gerrit change created: https://git.eclipse.org/r/144065
Comment 9 Eclipse Genie CLA 2019-06-14 10:22:10 EDT 
New Gerrit change created: https://git.eclipse.org/r/144065
Comment 10 Matthias Becker CLA 2019-06-14 10:23:38 EDT 
In org.eclipse.platform.doc.user we have a lot of help for the CVS Team provider.
As far is I know platform no longer ships with CVS. Does this mean we can remove all the CVS documentation?
Comment 11 Alexander Kurtakov CLA 2019-06-14 10:25:38 EDT 
(In reply to Matthias Becker from comment #10)
> In org.eclipse.platform.doc.user we have a lot of help for the CVS Team
> provider.
> As far is I know platform no longer ships with CVS. Does this mean we can
> remove all the CVS documentation?

Ideally it should be split in separate bundle and included in cvs feature. If this is not easily achievable we might need to come with different plan.
Comment 12 Dani Megert CLA 2019-06-14 10:26:45 EDT 
(In reply to Matthias Becker from comment #10)
> In org.eclipse.platform.doc.user we have a lot of help for the CVS Team
> provider.
> As far is I know platform no longer ships with CVS. Does this mean we can
> remove all the CVS documentation?
No. CVS is not part of the Eclipse SDK download but it can either be downloaded from the download page or installed from the repository.
Comment 13 Dani Megert CLA 2019-06-14 10:27:32 EDT 
(In reply to Alexander Kurtakov from comment #11)
> (In reply to Matthias Becker from comment #10)
> > In org.eclipse.platform.doc.user we have a lot of help for the CVS Team
> > provider.
> > As far is I know platform no longer ships with CVS. Does this mean we can
> > remove all the CVS documentation?
> 
> Ideally it should be split in separate bundle and included in cvs feature.
> If this is not easily achievable we might need to come with different plan.
Note that the doc does not appear when CVS is not installed. So, not sure you want to spend time on such an effort.
Comment 14 Matthias Becker CLA 2019-06-14 10:29:46 EDT 
(In reply to Dani Megert from comment #13)
> (In reply to Alexander Kurtakov from comment #11)
> > (In reply to Matthias Becker from comment #10)
> > > In org.eclipse.platform.doc.user we have a lot of help for the CVS Team
> > > provider.
> > > As far is I know platform no longer ships with CVS. Does this mean we can
> > > remove all the CVS documentation?
> > 
> > Ideally it should be split in separate bundle and included in cvs feature.
> > If this is not easily achievable we might need to come with different plan.
> Note that the doc does not appear when CVS is not installed. So, not sure
> you want to spend time on such an effort.

You can find the CVS documentation via the "Search" function of the help - it least I can find it....
Comment 15 Alexander Kurtakov CLA 2019-06-14 10:36:22 EDT 
(In reply to Matthias Becker from comment #14)
> (In reply to Dani Megert from comment #13)
> > (In reply to Alexander Kurtakov from comment #11)
> > > (In reply to Matthias Becker from comment #10)
> > > > In org.eclipse.platform.doc.user we have a lot of help for the CVS Team
> > > > provider.
> > > > As far is I know platform no longer ships with CVS. Does this mean we can
> > > > remove all the CVS documentation?
> > > 
> > > Ideally it should be split in separate bundle and included in cvs feature.
> > > If this is not easily achievable we might need to come with different plan.
> > Note that the doc does not appear when CVS is not installed. So, not sure
> > you want to spend time on such an effort.
> 
> You can find the CVS documentation via the "Search" function of the help -
> it least I can find it....

And it's referenced from other places like Workbench User Guide > Concepts > Workbench Related concepts has CVS Repositories so it's definitely there. Whether you want to spend time on this daunting task is up to you.
Comment 16 Matthias Becker CLA 2019-06-24 04:34:45 EDT 
(In reply to Eclipse Genie from comment #9)
> New Gerrit change created: https://git.eclipse.org/r/144065

Can somebody pls. review and verify this change?
Comment 18 Eclipse Genie CLA 2019-06-25 09:33:34 EDT 
New Gerrit change created: https://git.eclipse.org/r/144844
Comment 20 Eclipse Genie CLA 2019-06-26 04:56:55 EDT 
New Gerrit change created: https://git.eclipse.org/r/144907
Comment 21 Eclipse Genie CLA 2019-06-26 04:57:37 EDT 
New Gerrit change created: https://git.eclipse.org/r/144907
Comment 22 Matthias Becker CLA 2019-06-26 04:58:54 EDT 
(In reply to Eclipse Genie from comment #20)
> New Gerrit change created: https://git.eclipse.org/r/144907

This is the first commit that replaces icons in org.eclipse.jdt.doc.user.
As there are a lot of them I split them over multiple commits so that reviewers still can handle it.
Comment 23 Eclipse Genie CLA 2019-06-28 07:35:46 EDT 
New Gerrit change created: https://git.eclipse.org/r/144907
Comment 24 Matthias Becker CLA 2019-07-04 03:00:53 EDT 
(In reply to Eclipse Genie from comment #23)
> New Gerrit change created: https://git.eclipse.org/r/144907

Can somebody review this before M1?
Comment 25 Alexander Kurtakov CLA 2019-07-04 06:57:13 EDT 
(In reply to Matthias Becker from comment #24)
> (In reply to Eclipse Genie from comment #23)
> > New Gerrit change created: https://git.eclipse.org/r/144907
> 
> Can somebody review this before M1?

On it now. In the future just feel free to push yourself if no one reviews in timely manner. We do trust every committer :).
Comment 27 Matthias Becker CLA 2019-07-04 07:31:37 EDT 
(In reply to Alexander Kurtakov from comment #25)
> On it now. In the future just feel free to push yourself if no one reviews
> in timely manner. We do trust every committer :).

Thank you for that. But as this was just such a big change I explicitly wanted another pair of eyes on it..
Comment 28 Matthias Becker CLA 2019-07-04 07:31:57 EDT 
(In reply to Eclipse Genie from comment #26)
> Gerrit change https://git.eclipse.org/r/144907 was merged to [master].
> Commit:
> http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/
> ?id=9522a05020abb8f45a56698e23880b29a0ede9c9

Thank you for reviewing...
Comment 29 Eclipse Genie CLA 2019-07-12 08:52:23 EDT 
New Gerrit change created: https://git.eclipse.org/r/145986
Comment 30 Eclipse Genie CLA 2019-07-12 08:52:25 EDT 
New Gerrit change created: https://git.eclipse.org/r/145985
Comment 31 Eclipse Genie CLA 2019-07-12 08:52:27 EDT 
New Gerrit change created: https://git.eclipse.org/r/145984
Comment 32 Eclipse Genie CLA 2019-07-12 08:52:28 EDT 
New Gerrit change created: https://git.eclipse.org/r/145987
Comment 33 Eclipse Genie CLA 2019-07-12 08:52:30 EDT 
New Gerrit change created: https://git.eclipse.org/r/145989
Comment 34 Eclipse Genie CLA 2019-07-12 08:52:32 EDT 
New Gerrit change created: https://git.eclipse.org/r/145988
Comment 35 Eclipse Genie CLA 2019-07-12 08:52:34 EDT 
New Gerrit change created: https://git.eclipse.org/r/145992
Comment 36 Eclipse Genie CLA 2019-07-12 08:52:38 EDT 
New Gerrit change created: https://git.eclipse.org/r/145990
Comment 37 Eclipse Genie CLA 2019-07-12 08:52:40 EDT 
New Gerrit change created: https://git.eclipse.org/r/145994
Comment 38 Eclipse Genie CLA 2019-07-12 08:52:42 EDT 
New Gerrit change created: https://git.eclipse.org/r/145993
Comment 39 Eclipse Genie CLA 2019-07-12 08:52:46 EDT 
New Gerrit change created: https://git.eclipse.org/r/145996
Comment 40 Eclipse Genie CLA 2019-07-12 08:52:48 EDT 
New Gerrit change created: https://git.eclipse.org/r/145991
Comment 41 Eclipse Genie CLA 2019-07-12 08:52:52 EDT 
New Gerrit change created: https://git.eclipse.org/r/145997
Comment 42 Eclipse Genie CLA 2019-07-12 08:52:54 EDT 
New Gerrit change created: https://git.eclipse.org/r/145998
Comment 46 Eclipse Genie CLA 2019-07-12 09:20:16 EDT 
New Gerrit change created: https://git.eclipse.org/r/145987
Comment 47 Eclipse Genie CLA 2019-07-12 09:20:18 EDT 
New Gerrit change created: https://git.eclipse.org/r/145988
Comment 48 Eclipse Genie CLA 2019-07-12 09:20:32 EDT 
New Gerrit change created: https://git.eclipse.org/r/145989
Comment 49 Eclipse Genie CLA 2019-07-12 09:20:34 EDT 
New Gerrit change created: https://git.eclipse.org/r/145990
Comment 50 Eclipse Genie CLA 2019-07-12 09:20:35 EDT 
New Gerrit change created: https://git.eclipse.org/r/145991
Comment 51 Eclipse Genie CLA 2019-07-12 09:20:48 EDT 
New Gerrit change created: https://git.eclipse.org/r/145997
Comment 52 Eclipse Genie CLA 2019-07-12 09:20:49 EDT 
New Gerrit change created: https://git.eclipse.org/r/145998
Comment 64 Eclipse Genie CLA 2019-08-06 08:13:32 EDT 
New Gerrit change created: https://git.eclipse.org/r/147103
Comment 66 Lars Vogel CLA 2019-08-14 05:31:23 EDT 
(In reply to Eclipse Genie from comment #65)
> Gerrit change https://git.eclipse.org/r/147103 was merged to [master].
> Commit:
> http://git.eclipse.org/c/www.eclipse.org/eclipse/news.git/commit/
> ?id=7f2f987eec5b0674ffe6edc1342c394210ea5f8c

I think this creates some validation errors. Please have a look via https://validator.w3.org/check
Comment 67 Eclipse Genie CLA 2019-08-14 06:06:16 EDT 
New Gerrit change created: https://git.eclipse.org/r/147704
Comment 69 Eclipse Genie CLA 2019-09-09 04:00:24 EDT 
New Gerrit change created: https://git.eclipse.org/r/149147
Comment 70 Matthias Becker CLA 2019-09-09 04:04:57 EDT 
(In reply to Eclipse Genie from comment #69)
> New Gerrit change created: https://git.eclipse.org/r/149147

Will merge into 4.14