🚀🚀 README for Hacktoberfest Participants 🚀🚀

[captn3m0]

Welcome to Hacktoberfest 2022! endoflife.date is a simple informational (open-source) website that details the support lifecycles of various products. If you are interesting in earning some swag and helping this project, read on. Please read this document completely before filing a Pull Request.

Before you get started, get to know the project a little bit. Open endoflife.date and browse around a little bit. Take a look at some of these recently merged PRs to get a better idea: #1598, #1603, #1552, #1596.

About the codebase

endoflife.date is built using Jekyll - the Ruby static site builder that powers GitHub Pages. The site is built and deployed to Netlify. Since the site is mostly informational, you don't need programming skills to contribute to the project.

👾 Recommended PRs and Changes

Here's some recommendations for good first contributions to the codebase. We've also made sure that there are enough details on linked issues for beginners to start working on them.

🆕 Release Updates

The bulk majority of PRs to the project are trivial release update PRs. You can see previously merged PRs using the release-updates label as a guide. If a new release has been made for a project that is currently being tracked on the endoflife.date website, we welcome PRs for updating the data around for that new release. If you make such a PR, here's a short checklist to follow:

• Have you updated all of the release cycles that might have got an update?
• Has any previous release reached end of life? Does that need updating?
• If it's a new major release (which needs a new release cycle to be added), do we have a corresponding EoL dates for it?
• Is the page automatically updated? If so, our automation bot might beat you to it.

💅 Design and Layout Changes

If you're comfortable with SASS, Jekyll, HTML, Javascript - we're looking for some help around easy to fix design issues on the website. Make sure you've read through the HACKING.md file and setup the project locally before you start working on these.

Note that we are looking for good clean code, and unmaintainable hacks might be rejected. Make sure your changes align with the Jekyll Philosophy (for eg using SCSS mixings and Jekyll best practices).

Click through the following issues to read more.

• Autofocus to search input
• Hide old releases by default
• Add Product Logo in the sidebar

The following require a better understanding of Jekyll and Liquid templating. A simple easy-medium-hard rating is here to help you decide as well.:

• Update API to use ChangeLog template (Medium)
• Generate RSS Feed for every product (Hard)
• Add a Last Modified Date (Easy)
• Support LTS Dates (Medium)
• Support Dark Mode (Medium)

🦄 Adding New Products

The Guiding Principles of the project state that "it exists to be useful to the readers". The more products we track, the more helpful we become. We're currently tracking 66 products, and we'd like to track more. Here's a list of suggested products that we think are worth tracking. File a PR for any of these! A few have links to upstream project websites to help you find the actual dates for these projects.

• Azure Kubernetes Service
• Internet Explorer
• Apache Tomcat
• iPad
• Samsung Galaxy Phones
• Plesk
• Linux Mint
• cPanel
• VMWare ESXi
• VMWare Horizon (VMware Horizon and Citrix #540)
• VMWare Citrix (VMware Horizon and Citrix #540)
• Microsoft Exchange, more
• Quickbooks
• Various Forza Games
• Movable Type
• Apache Cassandra
• Apache Mesos
• Rancher
• Docker
• Ceph
• Postfix
• Envoy
• HAProxy
• Apache (the webserver)
• Many other Atlassian, Oracle, and IBM products.

(This list is based on personal observations, requests from users, google keyword research, and this list maintained by @witchcraze.

If you'd like to create a new page for something that is not on the above list - that's okay as well. We haven't had to reject a product so far, and doubt we will reject what you propose. Just make sure it is a well known product. We are open to accepting devices, frameworks, languages, operating-systems, applications, and pretty much everything that has a support lifecycle of some sort. If in doubt, ask us.

In creating a new page, make sure you read through CONTRIBUTING.md to understand the file structure, and go through a few of previously merged PRs with the label new-product. Also, please read through the Guiding Principles to make sure your writing style and content is good enough and matches the rest of the site. Reading these will help you get onboarded faster and make sure that your PR sees a speedy merge.

📝 Changelog Links

Not all of the products on the website have their latest releases linked to a relevant page. Usually this is the changelog for that release or a blog post.

See this issue for all the details: #39

Miscellaneous Contributions

We have issues labelled as good first issue for easy to pick up contributions. All of these have a detailed comment at the bottom telling exactly what needs to be done, and what skills might be needed.

If you'd like to suggest a new product to track, please create a new issue. Issues are also welcome if you have any suggestions for the website in general - around design, visibility, accessibility, usability for eg.

👩‍🎓 How to file a Pull Request

For most trivial changes (mainly release update and small content fixes), you can make these using the GitHub UI itself - just to to the relevant file and click the Pencil icon:

Edit the file accordingly, then type a good title and description for your changes:

Click "Propose Changes" and then review the changes you've made before clicking "Create Pull Request". If you still need to make more changes, create a "Draft Pull Request" by clicking the dropdown on the "Create Pull Request" button:

.

You can change the PR from a Draft PR to a ready PR afterwards.

✅ Validating your changes

Once you file your Pull Request, Netlify will provide a list of checks for your changes. If one of the checks is failed, you can click Details and see through the errors, or one of the Maintainers will be there to help you soon.

If all of the checks pass, you can click the "Details" link on the "Deploy Preview" Status Check to see a preview of the website with your changes.

Click through, and validate your changes. Click all the links in the page you've changed and make sure they're not broken.

📑 Suggested Reading

Please make sure that you've gone through the Hacktoberfest Quality Standards and the Participation Guidelines.

Additionally, we have the following documents which should help you get familiar with the project and the codebase. You don't need to read all of these, and we've linked these docs above in cases where you must read any of them.

• HACKING.md contains instructions on setting up the codebase locally with Jekyll. Read this if you're planning to make complex changes or setting up the project locally.
• Guiding Principles - These help us make decisions around the content we have. If you'd like to make sure your PR gets a speedy approval, please read these to ensure your changes are aligned with the rest of the content. This is especially important if you are making non-trivial changes that deal with the content or add a new product.
• CONTRIBUTING.md - This walks you through the structure each product page takes, in detailed comments. Do read this if you are adding a new product page to the website.
• Code of Conduct - This project follows the Contributor Covenant Code of Conduct, which you can read at this link. You must read this and agree to abide by this at all times in your interactions with this project and its community.

❓ Questions?

If you have any questions, please create a new Discussion under the Hacktoberfest category. If you are picking up a new task, first check if there is already a PR for the same, and if not - create a Draft Pull Request as soon as you can so others do not pick up the same task.

This issue is pinned and locked permitted to keep this clean for Hacktoberfest related announcements. Please create a new Discussions in the Hacktoberfest category instead.