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

Bug 563674

Summary: Add a "Featured Project" to the home page
Product: Community Reporter: Wayne Beaton <wayne.beaton>
Component: WebsiteAssignee: Yi Liu <yi.liu>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: chris.guindon, karen.mcnaughton, mariateresa.delgado, nobody, shanda.giacomoni, thabang.mashologu
Version: unspecified   
Target Milestone: ---   
Hardware: PC   
OS: Linux   
See Also: https://git.eclipse.org/r/c/www.eclipse.org/home/+/169977
https://git.eclipse.org/c/www.eclipse.org/home.git/commit/?id=554e9a1aca682ecff115d7f85a0b336f7f4b228e
Whiteboard:
Attachments:
Description Flags
Screenshot
none
Eclipse.org in 2012 with Featured Project Section
none
Featured Project Wireframe
none
Featured Project and Featured Committer Mockup none

Description Wayne Beaton CLA 2020-05-28 09:27:15 EDT
Created attachment 283056 [details]
Screenshot

It would be cool to have a "featured project" listed on the webpage. I've attached a screenshot of what it might look like (essentially, a pared down version of what we display on projects.eclipse.org). Positioning this below the news items, but above the project metrics feels like the right location for it.

We'll set up a criteria for being featured. What I'm thinking (off the top of my head):

* project team has engaged in a release review in the last year;
* project repositories have at least five commits/month over the last three months;
* project metadata has a _reasonable_ one sentence description summary;
* project metadata includes a logo;
* project is in the mature phase; and
* project license is up-to-date (i.e., EPL-2.0)

These are all metrics that we can automate reasonably well. The notion of a _reasonable_ description summary is subjective and may require some investment of time (the EMO does try to ensure that these descriptions are reasonable when a project is first created, but this data can be modified arbitrarily by the project committers).

The featured project will be updated monthly. 

In a discussion earlier today, we talked about possibly curating a full year's list of curated featured projects annually. A lot can happen in a year and we could easily end up featuring stale or archived projects 10, 11, or 12 months later; IMHO, we have to make our selections no more than a quarter in advance of a project being featured.

The EMO will take care of working with project team to meet the criteria that we set. Specifically, we'll make sure that the project has a reasonable description summary and encourage the project team to acquire a logo if they do not already have one when we engage in release reviews. That should actually take care of the subjective elements.

I'm confident that we can come up with an easy query to identify those projects that meet the criteria that I've listed the above (the subjective elements notwithstanding); what I don't know right now is how to order them fairly (perhaps by date of their last release review?)
Comment 1 Christopher Guindon CLA 2020-05-29 13:21:13 EDT
Created attachment 283095 [details]
Eclipse.org in 2012 with Featured Project Section

(In reply to Wayne Beaton from comment #0)
> Created attachment 283056 [details]
> Screenshot
> 
> It would be cool to have a "featured project" listed on the webpage. I've
> attached a screenshot of what it might look like (essentially, a pared down
> version of what we display on projects.eclipse.org). Positioning this below
> the news items, but above the project metrics feels like the right location
> for it.

This brings me back to my first year at Eclipse where I was responsible for implementing and designing that section on our homepage:

http://web.archive.org/web/20120329071745/http://www.eclipse.org/

We stop doing it because it was time-consuming.

If we are going to bring this back, let's focus on making it super easy for us to update that section.

I am thinking that we should be able to update the content via a CMS such as projects.eclipse.org. 

We would then pull in the data with an API call similar to what we are doing now with News and Events via Eclipse Newsroom.

> These are all metrics that we can automate reasonably well. The notion of a
> _reasonable_ description summary is subjective and may require some
> investment of time (the EMO does try to ensure that these descriptions are
> reasonable when a project is first created, but this data can be modified
> arbitrarily by the project committers).
> 
> The featured project will be updated monthly. 


If we implement a way for you to control what we display in that section, you will be able to change it whenever you think it's a good time for changing it!

If we want to move forward with this, I think the first step would be to design a mock of how this would like on the homepage! 

This will help me define what information we need to capture in the CMS to allow us to control this section.
Comment 2 Christopher Guindon CLA 2020-05-29 13:34:04 EDT
We currently have a bug open to allow the Marketing team the ability to control our featured Story on all of our websites:

https://github.com/EclipseFdn/jquery-eclipsefdn-api/issues/16

We currently have the concept of a featured Story Footer and a Featured Story Header (Below the Jumbotron).

I am bringing this up since I am thinking that the "Featured Project" is simply a new type of "featured content".

This could allow us to define a featured project for each of our WG websites if we decided to do that. 

This would also allow us to display the same featured project on all our sites.

My point here is that staff responsible for the content would be able to control that!
Comment 3 Nobody - feel free to take it CLA 2020-05-29 13:45:01 EDT
+1 I will be working on a mockup of this as a next step and will let you know when it's been approved.
Comment 4 Nobody - feel free to take it CLA 2020-06-18 16:08:00 EDT
Created attachment 283349 [details]
Featured Project Wireframe
Comment 5 Nobody - feel free to take it CLA 2020-06-18 16:15:57 EDT
I've attached the Featured Project wireframe.
-We'd like to limit the "Announcements" and "Community News" to list only 2 of each type on the Eclipse.org home page
-If an announcement or news article has more than 100 characters in the description, we should add "..." to the end of the sentence
-Let me know where we pull our website icons from (I think it's font awesome, but the current page source says http://www.w3.org/2000/svg).I can make a recommendation or provide SVGs from Flaticon
-Can we hyperlink the title "Announcements" to https://newsroom.eclipse.org/news/announcements/ while keeping the font color grey?
-Can we hyperlink the title "Community News" to https://newsroom.eclipse.org/news/community-news/ while keeping the font color grey?
Comment 6 Nobody - feel free to take it CLA 2020-06-19 13:22:52 EDT
Also note that we should use these icons from Font Awesome 4.7.0 for the Announcements, Community News, and Featured Projects sections:
Announcements - https://fontawesome.com/v4.7.0/icon/comments
Community News - https://fontawesome.com/v4.7.0/icon/users
Featured Projects - https://fontawesome.com/v4.7.0/icon/rocket
Comment 7 Nobody - feel free to take it CLA 2020-08-19 14:38:45 EDT
FYI – I will be updating this mockup to add a "Featured Committer" section within the next week or so. This additional section will go on the left side of the "Featured Project" section.
Comment 8 Nobody - feel free to take it CLA 2020-08-20 17:03:56 EDT
Created attachment 283924 [details]
Featured Project and Featured Committer Mockup

Please note that we've now added a "Featured Committer" section next to the "Featured Project" section. See issue: https://bugs.eclipse.org/bugs/show_bug.cgi?id=566239
Comment 9 Yi Liu CLA 2020-09-24 10:06:39 EDT
Hello Christie and Chris,

I added some design at staging, 

https://staging.eclipse.org/home/

username: testuser
pass: plaintext

And I will work on the js soon.

Thanks,
Yi
Comment 10 Christopher Guindon CLA 2020-09-24 10:14:59 EDT
(In reply to Yi Liu from comment #9)
> Hello Christie and Chris,
> 
> I added some design at staging, 
> 
> https://staging.eclipse.org/home/
> 
> username: testuser
> pass: plaintext
> 
> And I will work on the js soon.
> 
> Thanks,
> Yi

Thanks for your work on this so far!

We need to define how we are planing to manage/curate featured projects and committer.

Wayne,

Do you have an idea on how you wish to maintain these new section on the list? We could create a json file in /home repo. 

You would simply need to update the json whenever you wish to update a project or a committer. We could add a start and end-date property in the json to allow us to create a list for a full year.

An other option is to simply keep this as HTML or build an API with a custom form in the Eclipse Newsroom.
Comment 11 Christopher Guindon CLA 2020-11-10 08:47:09 EST
@Yi,

Is it possible for you to push this back on staging?
Comment 12 Yi Liu CLA 2020-11-10 14:32:34 EST
(In reply to Christopher Guindon from comment #11)
> @Yi,
> 
> Is it possible for you to push this back on staging?

This is now on staging: https://staging.eclipse.org/

user: testuser
pass: plaintext


Wayne,
We're using this file to manage featured committers and projects: 
https://git.eclipse.org/r/c/www.eclipse.org/home/+/169977/3/js/data.json

Is it possible for you to provide initial content?

Thanks!
Comment 13 Karen McNaughton CLA 2020-11-12 10:48:35 EST
Hi all I'm checking back on this one as we are tracking a Trello card on it. Do you need anything from Marketing to push this across the line?
Comment 14 Yi Liu CLA 2020-11-12 11:01:32 EST
(In reply to Karen McNaughton from comment #13)
> Hi all I'm checking back on this one as we are tracking a Trello card on it.
> Do you need anything from Marketing to push this across the line?

Hello karen,
Thanks for checking! I have created the preview on staging: https://staging.eclipse.org/
user: testuser
pass: plaintext

I'm not sure if we gonna use API calls to pull data dynamically in the future.
For now, we're using this json file to manage featured committers and projects: 
https://git.eclipse.org/r/c/www.eclipse.org/home/+/169977/3/js/data.json

I have added one simple example. The data example:

{
    "committers": [
        {
            "name": "Christie Witt",
            "Committer to": "12 Jakarta Projects",
            "Committer since": "2018",
            "image": "/home/images/featured_contents/christie-witt.jpg",
            "url": "https://accounts.eclipse.org/users/cwitt"
        }
    ],

    "projects": [
        {
            "name": "Eclipse EMFStore",
            "description": "Eclipse EMFStore is a model repository (server) for EMF featuring.",
            "image": "/home/images/featured_contents/emfstore.png",
            "url": "https://www.eclipse.org/projects/"
        }
    ]
}



If this looks good to you, is it possible for you to provide initial content and images?

Thanks!
Comment 15 Christopher Guindon CLA 2020-11-12 11:14:05 EST
(In reply to Karen McNaughton from comment #13)
> Hi all I'm checking back on this one as we are tracking a Trello card on it.
> Do you need anything from Marketing to push this across the line?

Yes, we need the content for this new section!
Comment 16 Shanda Giacomoni CLA 2020-11-20 09:00:35 EST
There has been some discussion among the marketing team, and we think aligning the featured projects and committers with the newsletter would be the easiest way to update the content on a regular basis.

For featured committer, we would use the committer featured in the newsletter (ex Arjan Tijms for Nov 2020 - https://www.eclipse.org/community/eclipse_newsletter/2020/november/)

The newsletter has "New project proposals" and "New project releases" sections (see https://www.eclipse.org/community/eclipse_newsletter/2020/november/). Is there a fair and easy way to select a project from one of those lists to feature? Ideally, the marketing team can apply some basic criteria so we don't have to ask Wayne every month. Any ideas?
Comment 17 Wayne Beaton CLA 2020-11-20 09:21:33 EST
> there a fair and easy way to select a project from one of those lists to
> feature? Ideally, the marketing team can apply some basic criteria so we
> don't have to ask Wayne every month. Any ideas?

Frankly, I think that it would be wrong to exclude me from this process. I interact with committers more than anybody and should have the best insight.

We can generate various contribution stats to short list candidates, but the challenge is that community leaders aren't always the most prolific committers, so numbers aren't always the best way to pick.

As it is with projects, my recommendation is that we don't project this too far out (a lot can change over the period of a few quarters). A monthly meeting to identify potential featured committers who align with themes for the next couple of issues makes sense to me.

I'll work out some metrics for creating a short list.
Comment 18 Shanda Giacomoni CLA 2020-11-20 09:28:54 EST
That makes sense. Process wise, we will reach out to you when we start each newsletter to discuss which project we will feature when it launches. That way we have a few weeks to work together to find the project and we can do it monthly so it isn't out of date.

I'm adding these items to our newsletter checklist for December, but if you have a project you would like to feature in November I think the webdev team is just waiting on our decision.
Comment 19 Christopher Guindon CLA 2020-11-20 09:30:55 EST
(In reply to Shanda Giacomoni from comment #18)

> I'm adding these items to our newsletter checklist for December, but if you
> have a project you would like to feature in November I think the webdev team
> is just waiting on our decision.

+1 We are waiting for the content before we can finalize this task and push this to production.
Comment 20 Shanda Giacomoni CLA 2020-11-30 14:50:41 EST
Heading should be "Featured Committer" and "Featured Project" (singular not plural)
Comment 21 Yi Liu CLA 2020-11-30 15:55:57 EST
Hello Shanda,
Thanks for your feedback and I have updated the patch and staging. 
https://staging.eclipse.org/
user: testuser
pass: plaintext
Comment 22 Christopher Guindon CLA 2020-12-03 10:52:47 EST
Yi,

We are planning to go live with this with the next release of the Eclipse Newsletter.

You can expect the content to be provided to you via the December Newsletter request/bug.
Comment 24 Yi Liu CLA 2020-12-18 16:15:48 EST
Hi All,
the new design is live on https://www.eclipse.org/.
I'm going to mark this as resolved, please feel free to reopen if more changes are needed.

Thanks!