This is the source code for the website at attic.apache.org which manages ASF projects which have retired.
This site uses Jekyll, which is a static site generator, with the Just The Docs Theme. See:
- The Jekyll Docs on how to install Jekyll and build this site locally.
- Just The Docs on configuring the theme
The Attic Website is composed of the following:
- Simple
markdownpages such as the home (index.md) and Process (process.md) pages. - A
yamlfile for each project in the_data/projectsdirectory 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.rbgenerates the project pages from the project'syamldata file._plugins/attic-banner-plugin.rbgenerates a flag file to indicate that the Attic Banner should be added to a project's website (based on the project'syamldata file)._plugins/cwiki-banner-plugin.rbgenerates a flag file to indicate that the Attic Banner should be added to the project's CWIKI spaces (based on the project'syamldata file).
The project YAML files contain the following information in order to generate the project pages:
- Retirement Date (usually the date of the board meeting the project was terminated)
- JIRA ID of the ticket used to track the project's move to the Attic
- Completion Date of the project's move to the Attic
- Project Description
- Source Code repositorie(s)
- Mailing Lists
- Issue Tracker(s)
- Wiki space(s)
- Download Details
- Related Projects
Creating/Updating a project's YAML file updates the project page, updates the Tracking page and generates any required flags for the project's website and wiki.
The structure of the project YAML file is shown below:
retirement_date: yyyy-mm-dd ### [REQUIRED] Date the project retired (date of board meeting)
attic_issue: ATTIC-XXX ### [OPTIONAL] The JIRA-ID managing the projects retirement
attic_date: yyyy-mm-dd ### [OPTIONAL] Date the move to the Attic was completed
attic_banner: true ### [OPTIONAL] Valid values: true/false (should banner be generated, normally true)
revived_date: yyyy-mm-dd ### [OPTIONAL] Date the project was revived - moved out of the Attic
project_name: [Another Name] ### [OPTIONAL] defaults to this file name
project_longname: ### [OPTIONAL] defaults to this file name
project_domain: [alt domain] ### [OPTIONAL] defaults to this file name + ".apache.org"
project_description: >-
[Project description here]
additional_text: >-
[Put some text here]
board_resolution: true ### [REQUIRED] Valid values: true/false (link to board minutes from retirement date?)
board_reports: true ### [REQUIRED] Valid values: true/false (include Board Reports section?)
downloads: true ### [REQUIRED] Valid values: true/false (include Downloads section?)
archive_path: ### [OPTIONAL] Defaults to this file name
source_repositories:
- type: Git ### [REQUIRED] Valid Values: Subversion, Git (may have both)
path: [some/path] ### [OPTIONAL] Defaults to this file name
mailing_lists:
- dev
- commits
- user
mailing_lists_prefix: ### [OPTIONAL] Defaults to this file name
issue_tracker:
type: JIRA ### [REQUIRED] Valid Values: JIRA, Bugzilla
keys:
- JIRA_KEY_1 ### [OPTIONAL] Defaults to this file name
wiki:
type: CWIKI ### [REQUIRED] Valid values: CWIKI
keys:
- WIKI_KEY_1 ### [OPTIONAL] Defaults to this file name
related_projects_text: >-
[Put some description here] ### [OPTIONAL]
related_projects:
- name: ### [OPTIONAL]
url: ### [OPTIONAL]
description: ### [REQUIRED]
Heres an example of a file for Any23:
retirement_date: 2023-06-21
attic_issue: ATTIC-215
attic_date: 2023-10-01
attic_banner: true
project_description: >-
The mission of Apache Any23 (Anything to Triples) was the creation and
maintenance of software related to automatic crawling, parsing, analyzing,
producing, validating and converting RDF (Resource Description Framework) data.
board_resolution: true
board_reports: true
downloads: true
source_repositories:
- type: Git
mailing_lists:
- dev
- commits
- user
issue_tracker:
type: JIRA
wiki:
type: CWIKI