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 301de3b Minor style/wording changes
301de3b is described below
commit 301de3b0ee87224edc914950522d2fbc16c849bd
Author: Niall Pemberton <[email protected]>
AuthorDate: Mon May 5 06:20:30 2025 +0100
Minor style/wording changes
---
index.md | 29 ++++++++++++++---------------
process-howto.md | 20 ++++++++++----------
process.md | 16 +++++++---------
3 files changed, 31 insertions(+), 34 deletions(-)
diff --git a/index.md b/index.md
index 495d604..e02c1b8 100644
--- a/index.md
+++ b/index.md
@@ -26,13 +26,11 @@ limitations under the License.
The Apache Attic was created in
[November
2008](https://www.apache.org/foundation/records/minutes/2008/board_minutes_2008_11_19.txt)
to provide process and solutions to make it clear when an Apache project has
reached its
-end of life. Specifically, the Apache Attic Project:
+end of life. Specifically:
-
-```
-[...] is responsible for the oversight of projects which otherwise would not
have oversight;
-[...] is not authorized to actively develop and release the projects under its
oversight
-```
+the Apache Attic [...] is responsible for the oversight of projects which
otherwise would not have oversight;
+the Apache Attic [...] is not authorized to actively develop and release the
projects under its oversight
+{: .text-grey-dk-300 .bg-grey-lt-000 style="font-family:SFMono-Regular;"}
It is intended to:
- Be non-impacting to users
@@ -44,12 +42,13 @@ It is not intended to:
- Make bugfixes
- Make releases
-### Getting into the Attic
+## Getting into the Attic
There are two expected mechanisms by which a project may enter the Attic.
Either the managing
Project Management Committee (PMC) decides it would like to move the project,
or The
Apache Software Foundation's board dissolves the PMC and chooses to move the
project.
-First step is to add a suitable resolution to the next board agenda: see the
+{: .important}
+The first step is to add a suitable resolution to the next board agenda: see
the
[Board Resolution Template]({% link resolution.md %}).
Once the submitted resolution has been approved during a board meeting, the
Attic project starts
@@ -60,9 +59,9 @@ Projects whose PMC are unable to muster 3 votes for a
release, who have no activ
are unable to fulfill their reporting duties to the board are all good
candidates for the Attic.
### Process of moving into the Attic
-This is defined in greater details in the separate [process]({% link
process.md %}) document.
+This is defined in greater details in the separate *[Process]({% link
process.md %})* document.
-### Process of leaving the Attic again
+## Process of leaving the Attic again
Options are:
- Forking the project outside the Apache Software Foundation - we'll link to
any forks which
@@ -80,7 +79,7 @@ assets (code-base, TLP website, maven group-id etc) to the
receiving PMC.\
After the transfer the receiving PMC will report to the Board about the
project's activities, and publish project releases in the PMC's dist area.
-### Contacting the Attic Project
+## Contacting the Attic Project
The Attic is a project as any other:
@@ -89,17 +88,17 @@ The Attic is a project as any other:
[[email protected]
archive](https://lists.apache.org/[email protected]).
You are welcome to subscribe and engage in discussion.
-### Retired Incubator Projects
+## Retired Incubator Projects
The [Apache Incubator](https://incubator.apache.org/) project is the entry
path into
The Apache Software Foundation for projects and codebases wishing to become
part of
the Foundation's efforts.
Not all projects
['graduate'](https://incubator.apache.org/cookbook/#graduation_vote)
out of the Incubator; some are retired instead. Those retired projects remain
under Incubator
-oversight: the list may be found on the Incubator's
-[Projects page](https://incubator.apache.org/projects/index.html#retired).
+oversight: the list may be found on the
+[Incubator's Projects
page](https://incubator.apache.org/projects/index.html#retired).
***
-### Preview Website Color Schemes
+## Preview Website Color Schemes
[JustTheDocs](https://just-the-docs.github.io/just-the-docs/docs/configuration/#color-scheme)
comes with **Light** and **Dark** schemes and this website uses a custom
diff --git a/process-howto.md b/process-howto.md
index ff4501b..459bc6b 100644
--- a/process-howto.md
+++ b/process-howto.md
@@ -27,12 +27,12 @@ limitations under the License.
{: .fs-5}
The sections below describe *How To* complete the various tasks to be done by
Attic team for retiring a project and moving it to The Apache Attic:
- - [1. Confirm Board Resolution](#1-confirm-board-resolution)
- - [2. Create project page on Attic
site:](#2-create-project-page-on-attic-site)
- - [3. Inform users of the move to the
Attic](#3-inform-users-of-the-move-to-the-attic)
- - [4. Update the project DOAP file (if
any):](#4-update-the-project-doap-file-if-any)
- - [5. Get infra lock down project's
resources](#5-get-infra-lock-down-projects-resources)
- - [6. Announce on [email protected]](#6-announce-on-announceapacheorg)
+ 1. [Confirm Board Resolution](#1-confirm-board-resolution)
+ 1. [Create project page on Attic site:](#2-create-project-page-on-attic-site)
+ 1. [Inform users of the move to the
Attic](#3-inform-users-of-the-move-to-the-attic)
+ 1. [Update the project DOAP file (if
any)](#4-update-the-project-doap-file-if-any)
+ 1. [Get Infra to lock down project's
resources](#5-get-infra-to-lock-down-project-resources)
+ 1. [Announce on *announce AT
apache.org*](#6-announce-on-announce-at-apacheorg)
The following are useful Git/svn/https locations:
@@ -63,8 +63,8 @@ and its rendered HTML in
[asf-site](https://github.com/apache/www-site/tree/asf-
## 2. Create project page on Attic site:
**https://attic.apache.org/projects/${project}.html**
-You can create a PR for the `${project}.yaml` file using the GitHub Action
-[Generate PR to add _data/projects/pid.yaml
file](https://github.com/apache/attic/actions/workflows/retire.yml).
+You can create a PR for the `${project}.yaml` file using the GitHub Action:
+[Create PR to add YAML
file](https://github.com/apache/attic/actions/workflows/retire.yml){: .btn
.fs-3 .v-align-bottom}
Click on 'Run workflow' and enter the lower case project id.
If the id is valid, the workflow will create a PR to add the YAML file.
@@ -124,7 +124,7 @@ add category: <category
rdf:resource="http://projects.apache.org/category/retir
You can use
[`script/project2attic.py`](https://github.com/apache/comdev-projects/blob/trunk/scripts/project2attic.py)
to prepare the update that you'll just need to
review and commit.
-## 5. Get infra lock down project's resources
+## 5. Get Infra to lock down project resources
Open an [Infrastructure Jira](https://issues.apache.org/jira/browse/INFRA)
issue identifying
the resources that need turning off/making read only.
@@ -144,7 +144,7 @@ Typically, it contains steps like following, that need to
be tweaked based on as
- Delete LDAP group(s)
- Turn off automated builds
-## 6. Announce on [email protected]
+## 6. Announce on *announce AT apache.org*
Announce that the project [is now
retired](https://lists.apache.org/[email protected]:lte=1M:%22is%20now%20retired%22).
diff --git a/process.md b/process.md
index 4f1508c..52b280d 100644
--- a/process.md
+++ b/process.md
@@ -45,15 +45,13 @@ to move that PMC into the Attic and gently close it down.
## 2. If the board approves the resolution
The Attic team will open an [Attic
JIRA](https://issues.apache.org/jira/browse/ATTIC) item - `Move ${project} to
the Attic`.
-Issue content typically contains following steps:
- - \# Confirm Board Resolution
- - \# Create project page on Attic site:
https://attic.apache.org/projects/${project}.html
- - \# Inform users of the move to the Attic
- - \# Update the project DOAP files (if any) or copy to
[projects-override](https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk/data/projects-override/)
- - \# Get infra lock down project's resources
- - \# Announce on [announce at
apache.org](https://lists.apache.org/[email protected]:lte=1M:%22is%20now%20retired%22)
-
-See [Attic Process - How To](process-howto.html) for a description of each
step that the Attic team will follow.
+Issue content typically contains the following steps (click for a description
of each step of the process):
+ 1. [Confirm Board Resolution](process-howto.html#1-confirm-board-resolution)
+ 1. [Create project page on Attic
site](process-howto.html#2-create-project-page-on-attic-site)
+ 1. [Inform users of the move to the
Attic](process-howto.html#3-inform-users-of-the-move-to-the-attic)
+ 1. [Update the project DOAP files (if
any)](process-howto.html#4-update-the-project-doap-file-if-any)
+ 1. [Get Infra to lock down project
resources](process-howto.html#5-get-infra-to-lock-down-project-resources)
+ 1. [Announce on *announce AT
apache.org*](process-howto.html#6-announce-on-announce-at-apacheorg)
Getting help from terminating project is welcome, particularly
on informing users step or any other useful action at project's level like
modifying DOAP file.
