Project Data YAML Files


Much of the content on this website is generated from project data files in YAML Format. This page describe the contents of how the data files are used and the attributes in the files:

How the Data Files are Used

The project YAML files are used to generate the following:

  • Project Pages
    • A Project Page is generated for each retired project which has details about the project, it’s retirement and its resources, such as Source Repositories, Mailing Lists, Downloads and Wikis
  • Template Pages
    • Projects which are In Process of being retired (i.e. those that don’t have an attic_date) have a generated template page. The page contains templates for the following:
      • Creating an Attic JIRA ticket to manage the project’s retirement
      • Creating an Infrastructure JIRA ticket to get the Infrastructure team to lock down the project’s resources
      • An Email to Inform Users about the project’s retirement
      • An Email to Announce the project’s retirement
  • Project Lists
    • The files are used to generate lists of projects on pages such as the Tracking Process, the Projects Page and the Navigation links on the left.
  • Site Banners
    • Setting the attic_banner=true attribute causes the “This project has retired” banner to be displayed on all the pages of the project’s website. It does this by generating a file in the flagged directory.
  • CWIKI Banners
    • Adding a wiki configuration with type=CWIKI causes the “This project has retired” banner to be displayed on all pages of the project’s CWIKI spaces. It does this by generating a file in the cwiki_retired directory.

Data File Attributes (YAML)

Attribute Required? Format/Values Description Examples
project_id GENERATED - Generated from the YAML file name, without the .yaml suffix  
retirement_date Required yyyy-mm-dd Date the project retired (date of board meeting)  
attic_issue Optional ATTIC-nnn The Attic JIRA ID managing the projects retirement  
attic_date Optional yyyy-mm-dd Date the move to the Attic was completed  
attic_banner Optional true/false Cause the Attic Banner to be displayed on the project’s website (normally true)  
project_type Optional PMC, Subproject Defaults to PMC (Historically Attic took in sub-projects, which is no longer the case)  
project_name Optional text defaults to the ${project_id} (capitialized)  
project_longname Optional text defaults to the ${project_name} ODE: YAML/Page
project_domain Optional domain name defaults to ${project_id}.apache.org Quetzalcoatl: YAML/Page
project_description Required text Description of the project  
project_shortdesc Optional text defaults either to the description in the retired_projects.json file or the first sentence of the ${project_description}  
additional_text Optional text Additional Text displayed on the project page below the project description Avalon: YAML/Page
board_resolution Required true/false If true, used to link to board minutes in combination with the ${retirement_date}  
board_reports Required true/false Cause a link to the project’s Board Reports be shown on the project’s page  
downloads Required true/false Cause a link to the archive donwload’s page for the project to be shown on the project page  
archive_path Optional path Path to the project’s download area. Defaults to the `${project_id} Joshua: YAML/Page
source_repositories Optional Array An array of the project’s sopurce respository types  
source_repositories: type Required Git, Subversion Type of Source Respository Git(Any23): YAML/Page
source_repositories: path Optional path Alternative respoitory path. Defaults to ${project_id} Subversion(OJB): YAML/Page
mailing_lists Optional Array List of the project’s public mailing lists (e.g. dev, user etc)  
mailing_lists_prefix Optional   mbox_prefix if required (usually for Subprojects) Xang: YAML/Page
issue_trackers Optional Array of Map Details of the project’s Issue tracker(s) ORO (Bugzilla): YAML/Page
issue_trackers: type Required JIRA, GitHub, Bugzilla Type of Issue Tracker Aurora (GitHub,JIRA): YAML/Page
issue_trackers: keys Optional Array List of Issue Tracker Key(s). Defaults to ${project_id} Apex (JIRA): YAML/Page
wiki Optional Map Details of the project’s Issue tracker(s)  
wiki: type Required CWIKI Type of Wiki. CWIKI causes the Attic Banner to be displayed on the CWIKI spaces  
wiki: keys Optional Array List of Wiki Key(s). Defaults to ${project_id} Eagle: YAML/Page
related_projects_text Optional text Text displayed before the list of related projects (if any) on the project’s page iBATIS: YAML/Page
related_projects Optional Array of Maps Details of Related Projects, shown at the bottom of the project page (if any) Hivemind: YAML/Page
related_projects: name Optional text Name of the related project  
related_projects: url Optional url URL of the related project  
related_projects: description Required text Description of the related project  

Example YAML File

Below is an example, of a YAML file for Any23 which generates the Any23 Project Page.

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_trackers:
    - type: JIRA
wiki:
    type: CWIKI

YAML Template File

The following is a standard starter template for a YAML file:

retirement_date: yyyy-mm-dd
attic_issue: ATTIC-nnn
attic_date:
attic_banner: true 
project_description: >-
    [put the project description here]
board_resolution: true
board_reports: true
downloads: true
source_repositories:
    - type: Git
mailing_lists:
    - dev
    - commits
    - user
issue_trackers:
    - type: JIRA
wiki:
    type: CWIKI

Copyright © 2009-2025 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache and the Apache feather logo are trademarks of The Apache Software Foundation.