This is an automated email from the ASF dual-hosted git repository.
niallp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/attic.git
The following commit(s) were added to refs/heads/main by this push:
new cd42f26 Remove YAML description from README.md and add link to the
Data Reference page
cd42f26 is described below
commit cd42f26062b638ab879a8091e3d94dbc4e23750d
Author: Niall Pemberton <[email protected]>
AuthorDate: Sat May 3 02:30:45 2025 +0100
Remove YAML description from README.md and add link to the Data Reference
page
---
README.md | 88 ++-------------------------------------------------------------
1 file changed, 2 insertions(+), 86 deletions(-)
diff --git a/README.md b/README.md
index fcbb84d..eede70a 100644
--- a/README.md
+++ b/README.md
@@ -48,92 +48,8 @@ The [Attic Website](https://attic.apache.org) is composed of
the following:
## Project YAML Data 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:
-
-```yaml
-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: >- ### [REQUIRED]
- [Project description here] ### Note that some characters - e.g. ':' -
require the text to be enclosed in ''
- [further description line] ### text can be continued on the next line,
keeping the same indentation
-additional_text: >- ### [OPTIONAL]
- [Put some text here] ### Note that some characters - e.g. ':' -
require the text to be enclosed in ''
-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: ### [REQUIRED] public mailing list names
- - dev
- - commits
- - user
-mailing_lists_prefix: ### [OPTIONAL] Defaults to this file name
-issue_trackers:
- - type: JIRA ### [REQUIRED] Valid Values: JIRA, Bugzilla
- keys:
- - JIRA_KEY_1 ### [OPTIONAL] Defaults to this file name
-wiki: ### [OPTIONAL] Not all projects have a 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**:
-
-```yaml
-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
-
-```
+Data for retired projects is stored in YAML, which are described on the Attic
+[Data Reference (YAML)](https://attic.apache.org/data.html) page.
## How to test locally (DRAFT) ##
