Apache Attic Website

This is the source code for the website at attic.apache.org which manages ASF projects which have retired.

Overview

This site uses Jekyll, which is a static site generator, with the Just The Docs Theme. See:

The site is built by the GitHub Workflow Action website.yml

Source is composed of the following:

Simple markdown pages such as the home (index.md) and Process (process.md) pages.
A yaml file for each project in the _data/projects directory which contains all the details about the project and its retirement
The Process Tracking (tracking.md) page which generates a table showing the status of each project generated from the files in `_data/projects' directory.
Jekyll Plugins which generate pages and files for the retired projects from the files in `_data/projects' directory:
- _plugins/projects-plugin.rb generates the project pages from the project's yaml data file.
- _plugins/attic-banner-plugin.rb generates a flag file to indicate that the Attic Banner should be added to a project‘s website (based on the project’s yaml data file).
- _plugins/cwiki-banner-plugin.rb generates a flag file to indicate that the Attic Banner should be added to the project‘s CWIKI spaces (based on the project’s yaml data file).

Data for retired projects is stored in YAML, which are described on the Attic Data Reference (YAML) page.

Install Ruby. Install bundler if necessary: gem install bundler

If you wish to install the required Gems locally (rather than updating the system Gems), change the bundler installation directory:

bundle config path 'vendor/bundle' --local

Now install the required gems:

bundle install

To build the site:

bundle exec jekyll build

To build the site and make it available at http://127.0.0.1:4000/

bundle exec jekyll server

To run retire.rb:

bundle exec ruby retire.rb projectId ...