Skip to content

Commit ffa838c

Browse files
committed
Improve copywriting
1 parent b36d6a7 commit ffa838c

File tree

4 files changed

+51
-64
lines changed

4 files changed

+51
-64
lines changed

content/collections/how-to/take-over.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,18 @@ weight: 4
55

66
# How to take over a collection
77

8-
Before starting, ensure the collection is [abandoned]({{< relref "collections/reference/status#abandoned" >}}) or [terminated]({{< relref "collections/reference/status#terminated" >}}).
8+
Before starting, ensure the collection is either [abandoned]({{< relref "collections/reference/status#abandoned" >}}) or [terminated]({{< relref "collections/reference/status#terminated" >}}). In any case, keep all original licenses, history, and attributions.
99

1010
## Steps
1111

12-
1. If the approval is not explicitly given in the collection's README.md file, get it by contacting owners via email if publicly available, a GitHub issue on the collection repository or on the [community chat]({{< relref "federation/how-to/join" >}}).
12+
1. If the approval is not explicitly given in the collection's README, get it by contacting owners via email if publicly available, a GitHub issue on the collection repository or on the [community chat]({{< relref "federation/how-to/join" >}}).
1313

14-
2. Ask the owner to transfer the repositories to your organization.
14+
2. Ask the owners to transfer the repositories to your organization.
1515

16-
3. Verify that the declarations, snapshots and versions repositories are transferred and properly configured by taking a look at [this guide]({{< relref "/collections/how-to/create-repositories" >}}).
16+
3. Check that the transferred declarations, snapshots and versions repositories are [properly configured]({{< relref "/collections/how-to/create-repositories" >}}).
1717

18-
4. Update the README.md file, and follow [this guide to update collection metadata]({{< relref "/collections/how-to/define-metadata" >}}) inside the declarations repository.
18+
4. Update the governance in the README files and in the [collection metadata]({{< relref "/collections/how-to/define-metadata" >}}) in the declarations repository.
1919

20-
5. Follow [this guide to deploy the collection]({{< relref "/deployment/how-to/deploy" >}}) on your server.
20+
5. Set up continous integration and deployment is working to [deploy the collection]({{< relref "/deployment/how-to/deploy" >}}) on your servers.
2121

22-
6. Ensure continous integration and deployment is working.
23-
24-
Congratulations! You can now start maintaining the collection.
25-
26-
Keep original licenses and attributions.
22+
Congratulations and thanks! You are now officially maintaining the collection.

content/collections/how-to/terminate.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,18 @@ weight: 3
55

66
# How to terminate a collection
77

8-
Follow these steps to properly terminate a collection you own, making it clear to users and potential successors that it is no longer actively maintained and can be taken over.
8+
If you don't have the resources to maintain a collection anymore, follow these steps to properly terminate it. This will make it clear to users and potential successors that it is no longer actively maintained and can be taken over.
99

1010
## Steps
1111

12-
1. Announce the intention to terminate the collection in the [community chat]({{< relref "/federation/how-to/join" >}}) to inform users and make potential new maintainers aware. Let some time, one month is recommended, for users to explicit their intenttion to take over the collection before proceeding to the next step.
12+
1. Announce the intention to terminate the collection in the [community chat]({{< relref "/federation/how-to/join" >}}) to inform users and make potential new maintainers aware. Give at least one month notice to that others have time to share their intention to take over the collection before proceeding to the next step.
1313

1414
If no-one has come forward after one month, you can proceed to the next step.
1515

16-
2. In the declarations repository's main `README.md` file, state that the collection is [terminated]({{< relref "collections/reference/status#terminated" >}}), encourage community to [take it over]({{< relref "collections/how-to/take-over" >}}). It can be done by adding the following snippet on the top of the file:
16+
2. In the declarations repository's README, state that the collection is [terminated]({{< relref "collections/reference/status#terminated" >}}), encourage community to take it over. It can be done by adding the following snippet on the top of the file:
1717

18-
```
19-
This collection is no longer actively maintained. If you are interested in taking over maintenance, please let us know in the [community chat]({{< relref "/federation/how-to/join" >}}).
20-
```
18+
> This collection is no longer actively maintained since `<date>`. New maintainers are encouraged to take over the operation of this collection in order to resume tracking its terms. Guidance on [taking over maintenance]({{< relref "collections/how-to/take-over" >}}) can be found in the Open Terms Archive documentation, and help is available in the Open Terms Archive [community chat]({{< relref "/federation/how-to/join" >}}).
2119
22-
3. [Archive the collection's repositories](https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories) (declarations, snapshots, versions) to prevent further commits and signal the end of activity.
20+
3. [Archive](https://docs.github.com/en/repositories/archiving-a-github-repository/archiving-repositories) the collection's repositories (declarations, snapshots, versions) to prevent further commits and signal the end of activity.
2321

24-
Once these steps are completed, the collection is officially terminated. It remains accessible but marked as inactive.
22+
Congratulations, the collection is now officially terminated! Thank you for clearly labelling it as inactive while keeping its contents accessible and enabling others to continue your work.

content/collections/reference/governance.md

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,78 +6,77 @@ aliases: /collections/governance/
66

77
# Collection governance
88

9-
Setting up and maintaining a collection needs fulfilling certain tasks. These tasks are handled through roles. Each of these roles can be volunteer or paid, and can be handled by one single or several different entities. The Open Terms Archive core team provides processes and tools to support all of these roles.
9+
Setting up and maintaining a collection entails fulfilling specific tasks. These tasks are handled through roles. Each of these roles can be volunteer or paid, and can be handled by one or several different entities.
1010

11-
This reference documentation details all available roles that can be involved in a collection's governance to ensure its proper operation and maintenance.
11+
This reference documentation details all roles that must be involved in a collection's governance to ensure its proper operation and maintenance.
1212

1313
## Roles
1414

15-
### `Host`
15+
### Host
1616

17-
Ensures the foundational infrastructure required for the collection's operation is available.
17+
Ensures the availability of the infrastructure required for the collection's operation.
1818

19-
**Responsibilities:**
19+
#### Responsibilities
2020

2121
- Provide the server infrastructure (self-hosted or rented).
22+
- Apply hypervisor security updates if relevant.
2223
- Guarantee reliable internet connectivity for the server to fetch terms.
2324

2425
---
2526

26-
### `Administrator`
27+
### Administrator
2728

2829
Manages the technical operation of the collection's software, ensuring it runs smoothly, stays updated, and remains secure.
2930

30-
**Responsibilities:**
31+
#### Responsibilities
3132

32-
- Keep the engine operational.
33-
- Ensure terms are tracked.
33+
- Ensure the engine runs at the specified schedule.
3434
- Ensure the public publishing of snapshots, versions, and datasets.
35-
- Maintain and update the engine-related infrastructure.
36-
- Apply necessary security patches to the infrastructure.
35+
- Keep the engine and deployment systems up-to-date.
36+
- Apply operating system security updates.
3737

3838
---
3939

40-
### `Curator`
40+
### Curator
4141

4242
Defines the collection's focus and ensures all included content aligns with that scope.
4343

44-
**Responsibilities:**
44+
#### Responsibilities
4545

4646
- Clearly define the collection's scope.
4747
- Make the collection scope publicly available via the metadata file.
48-
- Verify that included services and terms adhere to the defined scope.
48+
- Verify that included services and terms match the defined scope.
4949

5050
---
5151

52-
### `Maintainer`
52+
### Maintainer
5353

5454
Guarantees the integrity and quality of the collection's data by reviewing incoming contributions.
5555

56-
**Responsibilities:**
56+
#### Responsibilities
5757

5858
- Review contributions.
59-
- Maintain the quality of tracked versions (e.g., removing noise, ensuring completeness).
59+
- Maintain the quality of tracked versions (e.g. removing noise, ensuring completeness).
6060

6161
---
6262

63-
### `Contributor`
63+
### Contributor
6464

65-
Actively adds new service information and keeps existing entries current.
65+
Updates terms tracking and adds new entries.
6666

67-
**Responsibilities:**
67+
#### Responsibilities
6868

6969
- Add service declarations.
7070
- Keep service declarations up to date.
7171

7272
---
7373

74-
### `Sponsor`
74+
### Sponsor
7575

76-
Provides essential non-operational support, such as funding or resources, to facilitate the collection's success.
76+
Provides non-operational support such as funding or resources to facilitate the collection's success.
7777

78-
**Responsibilities:**
78+
#### Responsibilities
7979

80-
- Provide funding for collection operations.
81-
- Provide agent time for other roles.
80+
- Provide funding or in-kind contributions for collection operations.
8281
- Provide political or institutional support.
8382
- Make other relevant non-operational contributions.

content/collections/reference/status.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,38 +5,32 @@ weight: 5
55

66
# Collection status
77

8-
This reference documentation outlines the different status levels that a collection can have within the system. Understanding these statuses is crucial for users to assess a collection's reliability, maintenance level, and current operational state.
8+
This reference documentation outlines the different status levels that a collection can have within the system. Understanding these statuses is crucial for users to assess a collection's quality and reliability.
99

10-
### `Active`
10+
### Active
1111

12-
- The optimal operational state for a collection.
13-
14-
- The collection maintains regular record saving with actively maintained and updated terms declarations. The number of tracked terms remains stable or increases over time. The tracking quality is high and stable.
12+
The optimal operational state for a collection.
1513

14+
- The collection saves records regularly through actively maintained and updated terms declarations. The number of tracked terms remains stable or increases over time. The versions quality is high.
1615
- Technical maintenance includes regular dependency updates, access to the latest engine features, and benefits from all infrastructure updates.
17-
18-
- All roles filled and active.
16+
- All [roles]({{< relref "collections/reference/governance" >}}) are fulfilled.
1917

2018
---
2119

22-
### `Abandoned`
23-
24-
- Collection may be functional but shows clear signs of neglect.
20+
### Abandoned
2521

26-
- Operational status has deteriorated significantly with unknown record saving status, no updates to terms declarations, declining number of tracked terms, and decreasing tracking quality.
22+
Collection may be functional but shows clear signs of neglect.
2723

24+
- Operational status has deteriorated significantly with unknown record saving status, no updates to terms declarations, declining number of tracked terms, and decreasing versions quality.
2825
- Technical maintenance has ceased completely, with no dependency updates, missing latest engine features, and no infrastructure updates.
29-
30-
- All roles are inactive.
26+
- All [roles]({{< relref "collections/reference/governance" >}}) are inactive.
3127

3228
---
3329

34-
### `Terminated`
35-
36-
- Collection has ceased all operational activities.
37-
38-
- Record saving is no longer active, though historical records remain accessible for reference purposes.
30+
### Terminated
3931

40-
- No technical maintenance is performed as the collection is no longer operational.
32+
Collection has voluntarily ceased all operational activities.
4133

42-
- No active roles exist as the collection is terminated.
34+
- No terms are tracked anymore, though historical records remain accessible for reference purposes.
35+
- No technical maintenance is performed.
36+
- All [roles]({{< relref "collections/reference/governance" >}}) are inactive.

0 commit comments

Comments
 (0)