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

Bug 451808

Summary: Add Solstice "thin" theme to download pages
Product: [Eclipse Project] Platform Reporter: David Williams <david_williams>
Component: RelengAssignee: David Williams <david_williams>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: daniel_megert, markus.kell.r
Version: 4.2   
Target Milestone: 4.5 M4   
Hardware: PC   
OS: Linux   
Whiteboard:
Bug Depends on: 421390, 453160, 453558    
Bug Blocks: 415793, 434596    
Attachments:
Description Flags
example of initial effort
none
Main Eclipse project download page
none
snapshot showing "fa-info-circle" icon.
none
"new and noteworthy" heading before moving paragraph
none
"new and noteworthy" heading after moving paragraph none

Description David Williams CLA 2014-11-17 03:34:57 EST
I think we are at the point where we can ?relatively? easily add "solstice theme" to all our DL pages, not just the "main" download page. 

Such as see main one, at 
http://download.eclipse.org/eclipse/downloads/

Compare with individual DL pages, unit tests, performance tests, etc.

http://download.eclipse.org/eclipse/downloads/drops4/N20141116-2000/

http://download.eclipse.org/eclipse/downloads/drops4/N20141116-2000/testResults.php

http://download.eclipse.org/eclipse/downloads/drops4/N20141116-2000/performance.php

You may notice, I removed many "headers" and "footers" already, basically in preparation for adding solstice theme. 

See https://eclipse.org/eclipse.org-common/themes/solstice/docs/ 
for complete docs. 

The "key" for us, is to use one of the "minimal" versions, like they do on bugzilla, etc. 

The problem is deciding between the "barebones" version: 

https://eclipse.org/eclipse.org-common/themes/solstice/html_template/barebone/header.php

and the "thin" version: 

https://eclipse.org/eclipse.org-common/themes/solstice/html_template/thin/header.php

They are similar, but the "thin" version has "bread crumbs", which I can see as a handy navigation aide ... but, does require some extra work to "work well", I believe? 

In particular, if possible, I would like to use the "HTML" version of these pages, which I *think* is possible ... because that way, it would "display the same" whether on eclipse.org, build.eclipse.org .... or ... some release engineers test machine :)
Comment 1 David Williams CLA 2014-12-01 03:34:59 EST
Created attachment 249042 [details]
example of initial effort

This is the result of editing "by hand" a local version of a download page, to make sure we can accomplish what we need to. 

I think I've taken it about as far as it can go, using the "static html" thin header, plus a moderate amount of customization. 

From here on, it may take a lot "deeper" modification to have it look as good as we'd like to. (such as left nav bar is too narrow, some <hn> tags display too large, etc.)
Comment 2 David Williams CLA 2014-12-01 03:40:55 EST
Dani and Markus, I know you both care a lot about "web appearances" so I didn't want you to be surprised about where we are likely to end-up for M4. I can make some small improvements, by M4, but will not be finished. 

And ... I know this "new look" will take some getting used to ... but ... I think its good for the project to get a fresh face, that is relatively consistent with other parts of "the solstice theme". 

I am at the point where I will need to start "checking in changes" and then fine-tuning over time. So, I wanted to be sure there were no objections.
Comment 3 Dani Megert CLA 2014-12-01 09:04:33 EST
(In reply to David Williams from comment #1)
> Created attachment 249042 [details]
> example of initial effort

David, can you also provide a preview for the main page
http://download.eclipse.org/eclipse/downloads/
?
Comment 4 David Williams CLA 2014-12-01 09:16:35 EST
Created attachment 249065 [details]
Main Eclipse project download page

(In reply to Dani Megert from comment #3)
> (In reply to David Williams from comment #1)
> > Created attachment 249042 [details]
> > example of initial effort
> 
> David, can you also provide a preview for the main page
> http://download.eclipse.org/eclipse/downloads/
> ?

yes, it looks pretty much as it does now. Just a little thinner on top (and, much better, for a download page).
Comment 5 Markus Keller CLA 2014-12-01 10:19:24 EST
(In reply to David Williams from comment #1)
Looks pretty good. I like the alternating row backgrounds in the download tables. Only the leftnav is a bit strange without any borders or background color.

I'm OK with doing the switch whenever you feel confident, and then do adjustments if necessary.
Comment 6 Dani Megert CLA 2014-12-01 10:55:38 EST
(In reply to Markus Keller from comment #5)
> (In reply to David Williams from comment #1)
> Looks pretty good. I like the alternating row backgrounds in the download
> tables. Only the leftnav is a bit strange without any borders or background
> color.
> 
> I'm OK with doing the switch whenever you feel confident, and then do
> adjustments if necessary.

+1.
Comment 7 David Williams CLA 2014-12-07 00:19:51 EST
The build from 

http://download.eclipse.org/eclipse/downloads/drops4/N20141206-2000/

has an index.php page that's about as good as we can do for M1. We can certain make changes ... but, I suspect some effort should go into converting (or "wrapping") other pages, because by doing so we may be in a better position to understand our "Eclipse Project" exceptions and special cases that we have to "style" ourselves. (i.e. instead of getting one "perfect" try to get several "good" and that might lead to a more representative customization that "works everywhere" for us. 

But, here are some observations and possible "todos"

<Aside: did anyone ever notice that "CVS Runim" was misspelled in left hand nav bar, with an 'e' missing, since 4.4!>

Note: I have removed the "delta pack" from the web page, consistent with bug 419246 but it is still on the download server, if anyone needs to get it, and/or look at it. 

The fonts/page as a whole is "larger" than previous. This will take some getting used to, but current one is has 14px fonts, and previous had 8 px fonts (which would be too small for "Solstice theme".) We may want to try "12 pt" or something, but the nav bar in upper left was reduced to 12 pt. and it required a *lot* of other tweeks to look right (explicitly setting padding, etc.,) -- just a "feature" of "Bootstrap" ... or, any library supplies "cool things" very easily ... unless you want to change/customize something, and then a lot of work. 

May want to use mono space font for main tables. 

The column with "file size" should be right justified. Probably checksum too. 


And now ... for a big change ...
Comment 8 David Williams CLA 2014-12-07 02:07:44 EST
The next "big idea" I have about this page, derives from the fact we have a lot of "categories" (headings) with only one item in them -- seldom a good idea. We currently have 16 categories (headings) with 61 downloadable items. The first two proposals, below, would not change the number of downloadable items ... but, third one would take it down to about 48. 

These suggestions are actually independent of "Solstice", but Solstice make the problem more obvious due to font changes, and similar. And ideally would make some of it easier to implement ... but, I've not found that yet.  

Alternative 1: 

Combine the "categories" so we end up with fewer of them -- in both the left nav bar, and the "heading", (same number of items to download, just grouped more) for example, 


    Eclipse p2 Repository
    Eclipse SDK
    Platform Runtime Binary
    SWT binary and Source
    JDT Deliverables
    PDE Deliverables
    RCP Convenience Packages
    Other Deliverables

Alternative 2: 

Similar to above, but if we could figure out an *easy*, mostly "built-in" way of having "fly out" menus (visible only when hovered over), we could have "sub-categories" under the above, such as 

    Eclipse p2 Repository
    Eclipse SDK
    Platform Runtime Binary
    SWT binary and Source
    JDT Deliverables
        JDT Runtime Binary
        JDT SDK
        JDT Core Batch Compiler
    PDE Deliverables
        PDE API Tools fragments
        PDE Runtime Binary
        PDE SDK
    RCP Convenience Packages
        RCP Runtime Binary
        RCP SDK
    Other Deliverables
        Example Plug-ins
        CVS Runtime
        CVS SDK
        Releng Tools
        JUnit Plugin Tests and Automated Testing Framework

Alternative 3. My personal favorite, 

I've always thought we did not need so many "slices" of the repository. (bug 403811). Seems to me that (nearly) everything that is a "repo" on that page can be obtained from the main p2 repo, so there is no need for us to supply them redundantly. If anything, we could provide instructions on "how people can re-create their own small repositories" if for some reason that help them transition their build system, or similar. In fact, if anything, we could have one *big* zipped repo of everything. Most consumers would find that much more useful. In that case, we'd only have about 5 nav items and headings and about 47 or so items to download, and greatly reduced "download page" (in size of page, that is).


    Eclipse p2 Repository
    Eclipse SDK
    Platform Runtime Binary
    SWT Standalone Jars
    JDT Standalone compiler
Comment 9 David Williams CLA 2014-12-07 02:55:32 EST
(In reply to David Williams from comment #8)

Forgot to mention, I put a *rough* *prototype* of the new categories, in Git repo, if it helped anyone visualize the rough idea of what would change. 

http://git.eclipse.org/c/platform/eclipse.platform.releng.aggregator.git/plain/eclipse.platform.releng.tychoeclipsebuilder/eclipse/publishingFiles/templateFiles/ExampleOutput/indexNewGroups.html
Comment 10 Markus Keller CLA 2014-12-08 06:09:31 EST
In http://download.eclipse.org/eclipse/downloads/drops4/I20141207-2000/ , the "Downloads" breadcrumb item links to
http://download.eclipse.org/eclipse/downloads/downloads/ , which has one "/downloads" too much.

I don't care too much about the categories, but the "line-height:1;" in the left-nav makes the two-line "JUnit Plugin Tests and Automated Testing Framework" look bad.
Comment 11 David Williams CLA 2014-12-08 09:22:12 EST
(In reply to Markus Keller from comment #10)
> In http://download.eclipse.org/eclipse/downloads/drops4/I20141207-2000/ ,
> the "Downloads" breadcrumb item links to
> http://download.eclipse.org/eclipse/downloads/downloads/ , which has one
> "/downloads" too much.

I've fixed this, the easy way, by using "../../" instead of "../../downloads". 
On "build machine" version, it still does something reasonable ... that is, at least not "object not found". To fix "really well" would have to write some script to "find out" where the most appropriate place was, depending on deployed machine, etc. But think "../../" works for most. 


> 
> I don't care too much about the categories, but the "line-height:1;" in the
> left-nav makes the two-line "JUnit Plugin Tests and Automated Testing
> Framework" look bad.

Yes, I was trying to get "everything to fit". And I'm sure more could be done by overriding "padding", or something, but I also wonder if that text is too long for a nav bar. Perhaps "Tests and Testing Framework" would suffice? I have changed it to that short phrase, for now. "By hand" at that URL so you can see what it looks like, and it Git for it will be in Monday night's build automatically, unless I hear otherwise.
Comment 12 David Williams CLA 2014-12-08 09:29:52 EST
(In reply to Markus Keller from comment #10)
> I don't care too much about the categories, ...

Does that mean you don't care for them? (i.e. don't like them) or you don't care if they are used, or not. 

I have to say, my latest thinking is that a "left nav" bar may not be the best construct to use, with Solstice anyway. We seem to have them "all over the place" and yet for the most part they are simply "hard coded" (i.e. not computed) and are pretty fragile for varying themes. 

Perhaps we should have a "table of contents" outline at the top of the page (full, normal width) and then that small floating "back to the top" arrow? 

(Just some thoughts, I've not actually looked or prototyped anything ... will study Solstice more, and ask Matt for advice too.)
Comment 13 Markus Keller CLA 2014-12-08 12:10:53 EST
I mostly use the eclipse-SDK-*** builds, and I guess the same applies to most visitors of these download pages. 

I guess it makes sense to keep
- Testing Framework
- JDT Core Batch Compiler
- SWT Binary and Source

The first two are not easily available by other means, and I guess standalone SWT should also be present somewhere. I agree with you that we should try to reduce the number of other "slices" (or completely get rid of them).

But as long as the categories don't get in my way, I don't care whether they are kept, made hierarchical, or completely removed.

My eyes just started to hurt when I saw the bad line wrapping. The "Tests and Testing Framework" title is a good solution, but you should also rename the section title (which still reads "JUnit Plugin Tests and Automated Testing Framework").
Comment 14 David Williams CLA 2014-12-09 11:37:06 EST
For the record, bug 453558 is where I've been "learning" what Solstice and its underlying libraries have to offer, from Christopher, 

It appears the "collapse" bootstrap function would work nicely ... but, a fair amount of "re-write". I'll see how much of that can be automated. (for next milestone)

http://getbootstrap.com/javascript/#collapse

I think that'd especially be handy on the "logs" pages, there each "list of logs" is so long, it is hard to find the general category of interest. 

But in the mean time, am leaning toward "phase 1" being just to broadened the "categories" for M5 to 
    Eclipse p2 Repository
    Eclipse SDK
    Platform Runtime Binary
    SWT binary and Source
    JDT Deliverables
    PDE Deliverables
    RCP Convenience Packages
    Other Deliverables

and/or getting rid of the "slices" of repositories, and providing our whole repo zipped up. Will try to get some "download numbers" for those and/or get wider community feedback on what's needed.
Comment 15 David Williams CLA 2014-12-09 11:46:19 EST
Additionally, from some "live" feedback from Dani, the "+" graphic next to each deliverable should be replaced with an "i" icon or "?" icon (I'll see if "Solstice" has a standard, for "more info"). 

Plus, it was questioned if the "left nav bar" need to be so prominent ... perhaps it could go "on the right side" instead? (Or, I wonder now, if we end up with relatively short list of categories (5 or 7) if it could just be a "drop down" menu off of bread crumb?) 

It was also mentioned the "checksums" seem too take more space than they deserve ... wondered if there could be one link to all checksums ... or ... something? (Also, clicking a download *should* go to "Foundation mirror page" (even if not literally mirrored) and it provides checksums too) ... not sure we are going to mirror page, at the moment -- that might be another bug ... need to investigate.)
Comment 16 Markus Keller CLA 2014-12-09 13:08:47 EST
On http://download.eclipse.org/eclipse/downloads/ , my 90% use case is to go straight to the test results. The link for that is a tiny 16x16 JUnit icon.

Could you turn the "(x of 3 platforms)" text into a link as well? IIRC, it once used to be like that.
Comment 17 Dani Megert CLA 2014-12-09 15:26:19 EST
(In reply to Markus Keller from comment #16)
> On http://download.eclipse.org/eclipse/downloads/ , my 90% use case is to go
> straight to the test results. The link for that is a tiny 16x16 JUnit icon.
> 
> Could you turn the "(x of 3 platforms)" text into a link as well? IIRC, it
> once used to be like that.

Yes, it was. +1 for that change.
Comment 18 David Williams CLA 2014-12-09 17:21:58 EST
(In reply to Markus Keller from comment #16)
> On http://download.eclipse.org/eclipse/downloads/ , my 90% use case is to go
> straight to the test results. The link for that is a tiny 16x16 JUnit icon.
> 
> Could you turn the "(x of 3 platforms)" text into a link as well? IIRC, it
> once used to be like that.

Fixed this regression with 
http://git.eclipse.org/c/platform/eclipse.platform.releng.aggregator.git/commit/?id=74d2d5354b2a777911b5ce3081cfc010405141a8

(And, now that I look at it, almost seems that column should be called "Test Status" and the initial "build status icon" just "go with" the Build Name in first column? [I won't make that change though, unless someone else says they love the idea.].
Comment 19 David Williams CLA 2014-12-09 23:49:14 EST
FYI, I've opened separate bugs for two of the problems mentioned earlier, 

Bug 454631 - finger print graphs are sometimes truncated on right
Bug 454663 - Problems with links to unit tests, in Solstice theme

and added them as blocking the umbrella bug: 

Bug 415793 - Improve Download page

I don't think I want to tweak much more, unless it would be to go with "alternative 1" in bug 454663 and have "no color" in links to unit tests. Both red and green will be much brighter than they were, plus, we lose the "Solstice built-in" behaviors of "hover", and similar (so, they hardly look like links at all!). But, not exactly a blocker. So I don't plan to make changes unless there's an outcry for that change. 

Unless there is any other "burning" issues, I'd like to close this for M4, and any other remaining improvements/problems be opened as separate bugs, and mark as blocking bug 415793. 

Just remembered ... I need to test with "new and noteworthy" linked in. I've not seen how that looks yet.
Comment 20 Dani Megert CLA 2014-12-10 03:57:03 EST
(In reply to David Williams from comment #18)
> (In reply to Markus Keller from comment #16)
> > On http://download.eclipse.org/eclipse/downloads/ , my 90% use case is to go
> > straight to the test results. The link for that is a tiny 16x16 JUnit icon.
> > 
> > Could you turn the "(x of 3 platforms)" text into a link as well? IIRC, it
> > once used to be like that.
> 
> Fixed this regression with 
> http://git.eclipse.org/c/platform/eclipse.platform.releng.aggregator.git/commit/?id=74d2d5354b2a777911b5ce3081cfc010405141a8

Thanks, looks good!

 
> (And, now that I look at it, almost seems that column should be called "Test
> Status"

+1


> and the initial "build status icon" just "go with" the Build Name in
> first column?
Not sure what you mean.
Comment 21 David Williams CLA 2014-12-10 11:10:19 EST
(In reply to Dani Megert from comment #20)

> > (And, now that I look at it, almost seems that column should be called "Test
> > Status"
> 
> +1
> 
> 
> > and the initial "build status icon" just "go with" the Build Name in
> > first column?
> Not sure what you mean.

I'll work up an example (next milestone). But in short, there's a 'library' icon we use for "build finished' and explanation point for "build failed". And it links to the same place the "build name" links to. So, just seems they "go together on the page. But, I'd like to mock up, to see what it looks like. 

There is one more change I'd like to make for M4, and that is to replace the "details" icon (a plus sign) with a more standard "info" icon. I'll attach screen shot, just to make sure no one thinks it's worse ... and we can maybe still improve in future.
Comment 22 David Williams CLA 2014-12-10 11:20:44 EST
Created attachment 249317 [details]
snapshot showing "fa-info-circle" icon.

This is one of (hundreds) of "built-in" icons in the "Solstice theme" (which in turn, come from Bootstraps "Font awesome" package [1], which in turn is based on 
"glyphicons" [2]. 

[1] https://fortawesome.github.io/Font-Awesome/examples/
[2] http://glyphicons.com/

I feel same making this change because it is a pretty literal "search/replace". 

I will check to make sure the <i ... syntax still passes w3c validation, and if not, use the "<span" notation ... since, they say "Font Awesome is designed to be used with inline elements (we like the <i> tag for brevity, but using a <span> is more semantically correct)."
Comment 23 David Williams CLA 2014-12-10 11:51:08 EST
(In reply to David Williams from comment #22)

> 
> I feel same making this change because it is a pretty literal
> "search/replace". 

I meant "safe" (not 'same') if not obvious. 

http://git.eclipse.org/c/platform/eclipse.platform.releng.aggregator.git/commit/?id=18e55d89fef18de70bff832c940c55ce0a701ecf

> 
> I will check to make sure the <i ... syntax still passes w3c validation, and
> if not, use the "<span" notation ... since, they say "Font Awesome is
> designed to be used with inline elements (we like the <i> tag for brevity,
> but using a <span> is more semantically correct)."

It did "pass". So, I'll go with "short form" as well. (I think this "icons" are implemented as "fonts" ... which I guess is to give the advantage of more easily staying "lined up" with text, literally, as well as color, size, etc.
Comment 24 David Williams CLA 2014-12-10 12:54:46 EST
Created attachment 249321 [details]
"new and noteworthy" heading before moving paragraph
Comment 25 David Williams CLA 2014-12-10 12:59:16 EST
Created attachment 249322 [details]
"new and noteworthy" heading after moving paragraph

I did test the display of the "new and noteworthy" heading. It would be similar for readme, and acknowledgments, as well as "warnings" such as pom updates needed. 

I found that the general "descriptive paragraph" cam *after* these other headings, so "move it up" to always be immediately after the "h1" heading that identifies the build. Seems an obvious fix ... not sure how it worked before? Just looked, and in M3 it cam "after" the "new and noteworthy" heading ... which doesn't make much sense, to me.
Comment 26 David Williams CLA 2014-12-10 13:05:44 EST
I will "back port" these latest web page changes to the maintenance branch (honestly, at this point, I'm never sure what comes from master, and what comes from maintenance, when it comes to "web pages" ... but, do know they pretty much have to "be the same" (for now). -- but, these won't show up into day's maintenance build. 

And, with that, will consider this bug "done". I have re-read it, and captured some of the open issues in other bugs, and made them "blocking" the umbrella bug of 


Bug 415793 - Improve Download page 

the three "new" ones, not already mentioned in previous comments, are 

Bug 454784 - Revisit checksums and their display 
Bug 454771 - consider putting "build status" icon near name, instead of "Test Status" column ....
Bug 454780 - left nav bar on download page, and elsewhere, needs work

If I missed any issues let me know (or, open the bug).
Comment 27 David Williams CLA 2014-12-10 17:30:46 EST
Just to document it, all this editing did cause one regression, which has been fixed: 

Bug 454813 - Regressed going to "mirror page" when item selected from DL page