Table of Contents generated with DocToc
- Development
- Build
- File and Directory structure
- Automation
- API
- Contributing Workflow
- Deployment
- Analytics
- Automation
endoflife.date uses Jekyll, the static website generator. This document helps you set the codebase locally. This isn't necessary for most content changes. Follow this guide if you are making layout, design, or code changes.
First, you will need to install Ruby and Bundler. Follow these instructions to install Ruby, and then run the following commands:
# Install bundler
gem install bundler
# Clone the project:
git clone --recurse-submodules git@github.com:endoflife-date/endoflife.date.git
cd endoflife.date
# Install dependencies (_Note: You must use Bundler 2 or greater_):
$ bundle install
# All of the following commands should run successfully at this point:
ruby --version
bundle --version
bundle exec jekyll --version
Run the site locally:
$ bundle exec jekyll serve --host localhost --port 4000
Browse to http://localhost:4000
and you should see the site running locally. If you find any errors at this stage, check Jekyll's troubleshooting page or ask a question in the Q&A category on GitHub Discussions.
Other Jekyll commands are documented on the Jekyll website, along with the command options for the build and serve commands.
- The layout for the products page is in
_layouts/post.html
- Product data is in the
products
directory. - Automation scripts that fetch latest releases are in the
_auto
directory. - We follow the Jekyll directory structure:
_includes
holds partial templates, such as the content for the<head>
tag.assets
includes CSS/JS/Logo images etc_plugins
holds scripts invoked by the Jekyll build code_config.yml
holds the Jekyll configuration, including list of plugins, exclude/include filelist, theme configuration, and plugin settings.Gemfile
andGemfile.lock
are package files for bundler.
_headers
holds the template for generating a list of custom HTTP headers, in the Netlify Headers Format. A rendered version (might be dated) of the file can be seen here._redirects
similarly holds the template for generating redirects from alternate URLs to main product pages, again in the Netlify format. You can see a rendered version here.Rakefile
configures the entrypoint for our automation scripts.robots.txt
is for web scraping robots.humans.txt
holds details about the people and tech behind the project.
Automation is currently focused towards fetching the latest releases for a given release cycle. Scripts for this are in the _auto
directory, and run using Rakefile
.
All scripts should have fallback data in some form.
The GKE data is fetched at build-time via GKE APIs by calling rake gke
.
The API is just JSON files generated in the api
directory by _plugins/create-json-files.rb
. The API is not stable, because the key names or release names are not consistent.
The API Documentation is available at https://endoflife.date/docs/api and is generated from an OpenAPI Specification file located at _data/openapi.yml
. The documentation is rendered Stoplight Elements.
If you just want to add a new product or make some trivial changes, please see CONTRIBUTING.md
. Else:
- Fork the project
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request
The code is built and deployed to Netlify under it's Open Source Plan. We use the following Netlify Features:
- Custom HTTP Headers (
_headers
file) - Custom Redirects (
_redirects
file)
The build script is kept in netlify.toml
.
There are no javascript trackers or analytics on the website. Netlify Analytics enabled as an experiment. Numbers from Netlify Analytics and Google Search Usability Reports are published on the wiki
The endoflife.date project runs a bit of automation on top of GitHub Actions to automate mundane tasks. This is primarily updating the latest version of each product, wherever possible. This is documented in the wiki.