eslint / eslint.org

ESLint website
Apache License 2.0
73 stars 60 forks source link

Implement links for participation in the OpenJS Foundation ESP Program #594

Open joeeames opened 2 days ago

joeeames commented 2 days ago

What problem do you want to solve?

The new ESP program (https://openjsf.org/ecosystem-sustainability-program) allows projects to participate and gain funding for further work. This issue is to provide a discussion forum for the changes required for ESLint to participate in the program. I will make a list of recommended changes, and then once we have final approval, HeroDevs or the ESLint maintainers will produce the PR's to effect the changes.

What do you think is the correct solution?

ESLint Site Change Recommendations

Summary

  1. Add a “support” page with content as outlined below
  2. Need an official “version support policy” statement
  3. Add a banner to the homepage that is dismissable, with a cookie that keeps the banner dismissed on future sessions, indicating that v7 and below are out of support, and v8 will soon be out of support
  4. Add a new top level nav item that points to the new version support page
  5. Add a “Previous Verisions” item to the documentation version dropdown list
  6. Add a link to the “Previous Versions” page on the left navigation
  7. Add to the Github README file a summary of the support information

1. New “Support” Page

—---------------------------------------------------------- start of content Version Support Status

We support only the latest version of ESLint. Major versions less than 9 are no longer supported.

Still on versions older than 9? Here are your options Upgrade to the latest version If possible, the best solution is to upgrade to the supported version of ESLint as this keeps you safe and gives you the best performance and features. Purchase extended commercial support: If you cannot migrate, but require a secure version of ESLint, you can obtain commercial security support for your applications to keep them secure. Stay on the unsupported versions If your application has no security requirements, then you can stay on one of the unsupported versions of ESLint, but be aware that this comes with multiple risks. Commercial Support The following companies offer commercial support services for jQuery.

HeroDevs offers security and compatibility support for EOL versions of ESLint through the OpenJS Ecosystem Sustainability Program and is an approved commercial support vendor. You can find out more about their Never Ending Support options here.

—---------------------------------------------------------- end of content

2. Banner on Home Page

The following banner will be added to the home page with the following changes: banner

3. New Top Level Nav Item

In the screenshot shown above, a new nav item will be added named “Version Support”

4. Previous Versions item in version dropdown on documentation pages

This link will point at the Version Support Page dropdown

4. Link on documentation left nav

A link will be added to the docs left nav pointing at the Version Support page sidenav

5. Github README changes

The following section will be added to the github README file right before “Code of Conduct”

Participation

Additional comments

No response

nzakas commented 2 days ago

Thanks for putting this together. Some thoughts/questions:

  1. Is the banner intended to talk about ESLint v7, which was last released in 2021? Might it be better to talk about ESLint v8 approaching EOL? How long prior to/after EOL does it make sense to show a banner? (I'm not a fan of persistent banners that people will just tune out.)
  2. I feel like the banner being purple draws undue attention to the announcement, as purple is our highlight color. Maybe we could choose a subtler color from our palette?
  3. I really don't like "Version Support" in the top nav. It doesn't seem to fit well there. I wonder if maybe we can put it elsewhere? Maybe it could replace the "Development" section on the homepage hero (right side) so that "Version Support" is right under the versions? And then maybe a link in the footer?
  4. I also feel like "Version Support" in the sidenav on the docs is way too high up. It seems like it should either be right above or right below "Migrate to 9.x".
  5. It seems like the right place for a big purple banner would be on an EOL'ed versions docs page. So when ESLint v8.x goes EOL, I think it would make sense to ensure people are aware that they're viewing an EOL'ed version.

So, my overall feedback is I feel like the proposed treatment is a bit heavy-handed for the intended audience, which is a small subsection of our userbase. I'd like to find a treatment that is findable but also not something most people need to skip over.

Do you have some examples from other partners that we could look at to consider alternatives?