This is an automated email from the ASF dual-hosted git repository.
hboutemy 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 70c9a51 extract process how to details from end-user process overview
70c9a51 is described below
commit 70c9a513d38b2c867f9144726167415c03e686e9
Author: Hervé Boutemy <[email protected]>
AuthorDate: Thu May 1 23:21:14 2025 +0200
extract process how to details from end-user process overview
---
data.md | 15 ++--
process.md => process-howto.md | 58 +++++----------
process.md | 163 +++++------------------------------------
3 files changed, 43 insertions(+), 193 deletions(-)
diff --git a/data.md b/data.md
index 7d67efa..105e0ba 100644
--- a/data.md
+++ b/data.md
@@ -1,8 +1,8 @@
---
layout: page
-title: Project Data
+title: Retired Projects Data
parent: Process
-nav_order: 2
+nav_order: 3
nav_exclude: false
---
{%- comment -%}
@@ -22,7 +22,7 @@ See the License for the specific language governing
permissions and
limitations under the License.
{% endcomment %}
-# Project Data YAML Files
+# Retired Projects Data YAML Files
***
Much of the content on this website is generated from
@@ -30,10 +30,11 @@ Much of the content on this website is generated from
[YAML Format](https://en.wikipedia.org/wiki/YAML). This page describe
the contents of how the data files are used and the attributes in the
files:
- - [How the Data Files are Used](#how-the-data-files-are-used)
- - [Data File Attributes (YAML)](#data-file-attributes-yaml)
- - [Example YAML File](#example-yaml-file)
- - [YAML Template File](#yaml-template-file)
+- [Retired Projects Data YAML Files](#retired-projects-data-yaml-files)
+ - [How the Data Files are Used](#how-the-data-files-are-used)
+ - [Data File Attributes (YAML)](#data-file-attributes-yaml)
+ - [Example YAML File](#example-yaml-file)
+ - [YAML Template File](#yaml-template-file)
## How the Data Files are Used
diff --git a/process.md b/process-howto.md
similarity index 72%
copy from process.md
copy to process-howto.md
index 76e369a..910d43e 100644
--- a/process.md
+++ b/process-howto.md
@@ -1,7 +1,7 @@
---
layout: page
-title: Process
-has_toc: false
+title: How To
+parent: Process
nav_order: 2
---
{%- comment -%}
@@ -21,40 +21,16 @@ See the License for the specific language governing
permissions and
limitations under the License.
{% endcomment %}
-# Moving a PMC to the Attic
+# Attic Process: How To
***
-At some point a PMC may want to join the Attic. The following defines a process
-to move that PMC into the Attic and gently close it down.
-
-1. A PMC decides to move to the Attic.
- - Conduct a discussion on the public developer list whether to dissolve the
PMC. Do not conduct
- it on the private PMC list.
- - Consider an appeal to the user list for interested users to provide their
interest in helping out more.
- - Consider whether any contributors might be candidates for promotion to
committers or PMC members.
- - Conduct a PMC vote on the public dev list.
- - If the PMC votes to dissolve the PMC and move to the Attic, inform the
board of the successful vote on
- board@ mailing list (linking or forwarding the 'successful' vote) and add
a resolution to dissolve the
- PMC to the next board meeting agenda.
- - If the PMC can't get enough people to vote to dissolve the PMC (and there
are not three -1 votes), then
- that is grounds for moving to the Attic. They should inform the board as
above, noting that the vote
- failed to get enough votes.
-1. If the board approves the resolution, open an [Attic
JIRA](https://issues.apache.org/jira/browse/ATTIC)
- item - 'Move ${project} to the Attic'.
- **TBA: this was previously generated by retire.py, but it has yet to be
converted to the new formats.**
- Generated issue content typically contains following steps (see ["How
to"](#how-to-general-pointers) below for a description
- of each step):
- - [#](#how-to-1-confirm-board-resolution) Confirm Board Resolution
- - [#](#how-to-2-create-project-page-on-attic-site) Create project page on
Attic site: https://attic.apache.org/projects/$project.html
- - [#](#how-to-3-inform-users-of-the-move-to-the-attic) Inform users of the
move to the Attic
- - [#](#how-to-4-update-the-project-doap-file-if-any) 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/)
- - [#](#how-to-5-get-infra-lock-down-projects-resources) Get infra lock down
project's resources
- - [#](#how-to-6-announce-on-announceapacheorg) Announce on [announce at
apache.org](https://lists.apache.org/[email protected]:lte=1M:%22is%20now%20retired%22)
-
-The Attic PMC will then execute the steps: getting help from terminating
project is welcome, particularly
-on informing users step or any other useful action at project's level like
modifying DOAP.
-
-### How to: General pointers
+- [Attic Process: How To](#attic-process-how-to)
+ - [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)
The following are useful Git/svn/https locations:
@@ -64,8 +40,8 @@ The following are useful Git/svn/https locations:
and
[/repos/infra](https://github.com/apache/infrastructure-p6/blob/production/modules/subversion_server/files/authorization/pit-authorization-template)
- websites
[svnpubsub](https://github.com/apache/infrastructure-p6/blob/production/modules/svnwcsub/files/svnwcsub.conf)
and
[infra-reports#sitesource](https://infra-reports.apache.org/#sitesource)
-
-### How to: 1. Confirm Board Resolution
+
+## 1. Confirm Board Resolution
Check previous Board minutes to confirm the "terminate" resolution passed. The
minutes are available from the following sources:
@@ -84,7 +60,7 @@ This automatically removes VP entry on
[https://www.apache.org/foundation/leader
([src](https://github.com/apache/www-site/blob/main/content/index.ezmd#L304)):
see [www-site](https://github.com/apache/www-site)
and its rendered HTML in
[asf-site](https://github.com/apache/www-site/tree/asf-site) branch.
-### How to: 2. Create project page on Attic site:
+## 2. Create project page on Attic site:
**https://attic.apache.org/projects/${project}.html**
The Attic Website uses [Jekyll](https://github.com/jekyll/jekyll), which
generates the
@@ -109,7 +85,7 @@ Once the page is live:
- Creating the Infra JIRA
- Templates for User & Announcement Emails
-### How to: 3. Inform users of the move to the Attic
+## 3. Inform users of the move to the Attic
Once the project page is live on the Attic website, you can use the project's
[Template Page]({% link tracking.md %}) to get a project specific text for the
@@ -129,7 +105,7 @@ Also bear in mind that the user mailing list may already
know and you can skip t
or you can get help from project having asked to move to the Attic. Make sure
you read that
thread if it does exist.
-### How to: 4. Update the project DOAP file (if any):
+## 4. Update the project DOAP file (if any):
**https://projects.apache.org/project.html?${project}**
The files referenced are in
[https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk]
@@ -146,7 +122,7 @@ new category: <category
rdf:resource="http://projects.apache.org/category/retir
You can use `script/project2attic.py` to prepare the update that you'll just
need to
review and commit
-### How to: 5. Get infra lock down project's resources
+## 5. Get infra lock down project's resources
Open an [Infrastructure JIRA](https://issues.apache.org/jira/browse/INFRA)
issue identifying
the resources that need turning off/making read only.
@@ -166,7 +142,7 @@ Typically, it contains steps like following, that need to
be tweaked based on as
- Delete LDAP group(s)
- Turn off automated builds
-### How to: 6. Announce on [email protected]
+## 6. Announce on [email protected]
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 76e369a..a4c3e7d 100644
--- a/process.md
+++ b/process.md
@@ -24,164 +24,37 @@ limitations under the License.
# Moving a PMC to the Attic
***
-At some point a PMC may want to join the Attic. The following defines a process
+At some point a PMC may want to join the Attic.
+
+The following defines a process
to move that PMC into the Attic and gently close it down.
-1. A PMC decides to move to the Attic.
+## 1. A PMC decides to move to the Attic
- Conduct a discussion on the public developer list whether to dissolve the
PMC. Do not conduct
it on the private PMC list.
- Consider an appeal to the user list for interested users to provide their
interest in helping out more.
- Consider whether any contributors might be candidates for promotion to
committers or PMC members.
- Conduct a PMC vote on the public dev list.
- If the PMC votes to dissolve the PMC and move to the Attic, inform the
board of the successful vote on
- board@ mailing list (linking or forwarding the 'successful' vote) and add
a resolution to dissolve the
+ board@ mailing list (linking or forwarding the 'successful' vote) and add
[a resolution](resolution.html) to dissolve the
PMC to the next board meeting agenda.
- If the PMC can't get enough people to vote to dissolve the PMC (and there
are not three -1 votes), then
that is grounds for moving to the Attic. They should inform the board as
above, noting that the vote
failed to get enough votes.
-1. If the board approves the resolution, open an [Attic
JIRA](https://issues.apache.org/jira/browse/ATTIC)
- item - 'Move ${project} to the Attic'.
- **TBA: this was previously generated by retire.py, but it has yet to be
converted to the new formats.**
- Generated issue content typically contains following steps (see ["How
to"](#how-to-general-pointers) below for a description
- of each step):
- - [#](#how-to-1-confirm-board-resolution) Confirm Board Resolution
- - [#](#how-to-2-create-project-page-on-attic-site) Create project page on
Attic site: https://attic.apache.org/projects/$project.html
- - [#](#how-to-3-inform-users-of-the-move-to-the-attic) Inform users of the
move to the Attic
- - [#](#how-to-4-update-the-project-doap-file-if-any) 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/)
- - [#](#how-to-5-get-infra-lock-down-projects-resources) Get infra lock down
project's resources
- - [#](#how-to-6-announce-on-announceapacheorg) Announce on [announce at
apache.org](https://lists.apache.org/[email protected]:lte=1M:%22is%20now%20retired%22)
-
-The Attic PMC will then execute the steps: getting help from terminating
project is welcome, particularly
-on informing users step or any other useful action at project's level like
modifying DOAP.
-
-### How to: General pointers
-
-The following are useful Git/svn/https locations:
-
- - site [source](https://github.com/apache/attic), built to
[`asf-site`](https://github.com/apache/attic/tree/asf-site) branch
- - [ATTIC Jira](https://issues.apache.org/jira/browse/ATTIC)
- - permissions on svn
[/repos/asf](https://github.com/apache/infrastructure-p6/blob/production/modules/subversion_server/files/authorization/asf-authorization-template#L231)
- and
[/repos/infra](https://github.com/apache/infrastructure-p6/blob/production/modules/subversion_server/files/authorization/pit-authorization-template)
- - websites
[svnpubsub](https://github.com/apache/infrastructure-p6/blob/production/modules/svnwcsub/files/svnwcsub.conf)
and
- [infra-reports#sitesource](https://infra-reports.apache.org/#sitesource)
-
-### How to: 1. Confirm Board Resolution
-
-Check previous Board minutes to confirm the "terminate" resolution passed. The
minutes are available from the following sources:
-
- - The private [[email protected] mailing
list](https://lists.apache.org/[email protected]:lte=2M:ASF%20Board%20Meeting)
(requires login)
- - Previously published [Board meeting
minutes](https://www.apache.org/foundation/board/calendar.html)
- - Whimsy has a public list of [Board Minutes by
topic](https://whimsy.apache.org/board/minutes/)
-
-However note that the most recent meeting minutes are not published until the
following meeting at the earliest.
-
-Check that Secretary removed the PMC from
[https://svn.apache.org/repos/private/committers/board/committee-info.txt](https://svn.apache.org/repos/private/committers/board/committee-info.txt)
-(see also [commits
history](https://lists.apache.org/[email protected])).
-
-This automatically removes VP entry on
[https://www.apache.org/foundation/leadership](https://www.apache.org/foundation/leadership)
-([src](https://github.com/apache/www-site/blob/main/content/foundation/leadership.ezmd))
and project from
-[https://www.apache.org/#projects-list](https://www.apache.org/#projects-list)
navigation
-([src](https://github.com/apache/www-site/blob/main/content/index.ezmd#L304)):
see [www-site](https://github.com/apache/www-site)
-and its rendered HTML in
[asf-site](https://github.com/apache/www-site/tree/asf-site) branch.
-
-### How to: 2. Create project page on Attic site:
-**https://attic.apache.org/projects/${project}.html**
-
-The Attic Website uses [Jekyll](https://github.com/jekyll/jekyll), which
generates the
-[Project Pages]({% link projects.md %}) from [project data
files]({{site.repo}}/blob/main/_data/projects/)
-in [YAML Format](https://en.wikipedia.org/wiki/YAML).
-
-Adding a project to the website is done by adding a YAML file for the project
to the
-[_data/projects]({{site.repo}}/blob/main/_data/projects/) directory.
-This is currently a manual process, but we hope to update
[`retire.py`](https://github.com/apache/attic/blob/main/retire.py) to automate
it back:
- - clone the Git [Attic Repository]({{site.repo}})
- - Create the project YAML file (see the [Project Data]({% link data.md %})
page
- for help on crafting the YAML file)
- - Commit the file to your clone and open a PR request
-
-Once the PR is merged, GitHub Action will automatically launch Jekyll to
generate the project page.
-
-Once the page is live:
- - Check the project site carries the **Attic Banner**
- - Check any CWIKI spaces carry the **Attic Banner**
- - Use the project's [Template Page]({% link tracking.md %}) to help with:
- - Creating the Attic JIRA
- - Creating the Infra JIRA
- - Templates for User & Announcement Emails
-
-### How to: 3. Inform users of the move to the Attic
-
-Once the project page is live on the Attic website, you can use the project's
-[Template Page]({% link tracking.md %}) to get a project specific text for the
-User email.
-The text will be based on the following template, replaced with project
specific values.
+## 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'.
-```
-{% include user-email-template.html name="${project}" attic_issue="ATTIC-${#}"
%}
-```
+**TBA: this was previously generated by retire.py, but it has yet to be
converted to the new formats.**
-Remember to [subscribe](https://www.apache.org/foundation/mailinglists.html)
to the user
-list: use [Whimsy Mailing List
Self-subscription](https://whimsy.apache.org/committers/subscribe)
-to avoid moderation (if the project hasn't been removed yet).
+Generated issue content typically contains following steps (see ["How
to"](process-howto.html) for a description
+of each step that the Attic team will follow):
+ - \# 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)
-Also bear in mind that the user mailing list may already know and you can skip
this stage,
-or you can get help from project having asked to move to the Attic. Make sure
you read that
-thread if it does exist.
-
-### How to: 4. Update the project DOAP file (if any):
-**https://projects.apache.org/project.html?${project}**
-
-The files referenced are in
[https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk]
-(https://svn.apache.org/repos/asf/comdev/projects.apache.org/trunk), which
every Apache committer can update.
-
-Identify whether the project has a DOAP file (see the <comdev
repo>/projects.apache.org/data/projects.xml file)
-and update the rdf file with PMC to the Attic and add a category of _retired_:
-
-```
-pmc change: <asfext:pmc rdf:resource="http://attic.apache.org"; />
-new category: <category
rdf:resource="http://projects.apache.org/category/retired"; />
-```
-
-You can use `script/project2attic.py` to prepare the update that you'll just
need to
-review and commit
-
-### How to: 5. Get infra lock down project's resources
-
-Open an [Infrastructure JIRA](https://issues.apache.org/jira/browse/INFRA)
issue identifying
-the resources that need turning off/making read only.
-
-Once the project page is live on the Attic website, you can use the project's
-[Template Page]({% link tracking.md %}) to get project specific content for
-the Infrastructure JIRA.
-
-Typically, it contains steps like following, that need to be tweaked based on
assets of the retired project:
-
- - Make source control Git\|Svn read-only
- - Remove files from
[dist.apache.org/repos/dist/\[release\|dev\]](https://dist.apache.org/repos/dist/)
- - Closing down of dev@, commits@ and private@ etc. [mailing
lists](https://lists.apache.org/)
- - Close down the user mailing list (unless still active - in which case
propose a moderator to Infra)
- - Make JIRA\|Bugzilla read-only
- - Make the wiki (if any) read-only
- - Delete LDAP group(s)
- - Turn off automated builds
-
-### How to: 6. Announce on [email protected]
-
-Announce that the project [is now
retired](https://lists.apache.org/[email protected]:lte=1M:%22is%20now%20retired%22).
-
-Once the project page is live on the Attic website, you can use the project's
-[Template Page]({% link tracking.md %}) to get a project specific text for the
-Announcement email.
-
-The text will be based on the following template, replaced with project
specific values.
-
-Sometimes, the user mailing list will not be shut down. If that is the case,
-it should be mentioned in the announce. e.g. add "The user mailing list
remains open."
-after "change in url." below.
-
-```
-{% include announce-email-template.html project_id="${project}"
name="${project}" longname="${project}" description="${project} was
{boilerplate}" %}
-```
-
-It's important to include the boilerplate from the project's site so people
know what we're talking about.
+The Attic PMC will then execute the steps: getting help from terminating
project is welcome, particularly
+on informing users step or any other useful action at project's level like
modifying DOAP.
