Attic

Clone this repo:
  1. e3fd6d6 Add text about XMLBeans being transferred to Apache POI in June 2018 & remove resource details by Niall Pemberton · 6 days ago main
  2. 44cc955 Change xmlbeans.txt to xmlbeans.yaml by Niall Pemberton · 6 days ago
  3. 427a1b2 Add a note that Apache Zest was renamed to Apache Polygene in Dec 2016 with link to the Board resolution by Niall Pemberton · 6 days ago
  4. 7d98004 DRAT doesn't have any releases - change "downloads" to false by Niall Pemberton · 9 days ago
  5. 477d83b Bump sass-embedded from 1.104.1 to 1.105.0 (#59) by dependabot[bot] · 4 weeks ago

Apache Attic Website

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

Issue tracking: https://issues.apache.org/jira/projects/ATTIC

Mailing list: general@attic.apache.org https://lists.apache.org/list.html?general@attic.apache.org

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).

Project YAML Data File

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

Attic banner description

For a description of how the Attic banners are managed, please see BANNER.md

How to test locally (DRAFT)

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 ...

Testing the Attic banner and CSP using Docker

There is a Docker build for testing the Attic banner and CSP