You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/collections/how-to/take-over.md
+7-11Lines changed: 7 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,18 @@ weight: 4
5
5
6
6
# How to take over a collection
7
7
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.
9
9
10
10
## Steps
11
11
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" >}}).
13
13
14
-
2. Ask the owner to transfer the repositories to your organization.
14
+
2. Ask the owners to transfer the repositories to your organization.
15
15
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" >}}).
17
17
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.
19
19
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.
21
21
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.
Copy file name to clipboardExpand all lines: content/collections/how-to/terminate.md
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,20 +5,18 @@ weight: 3
5
5
6
6
# How to terminate a collection
7
7
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.
9
9
10
10
## Steps
11
11
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.
13
13
14
14
If no-one has come forward after one month, you can proceed to the next step.
15
15
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:
17
17
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" >}}).
21
19
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.
23
21
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.
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.
10
10
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.
12
12
13
13
## Roles
14
14
15
-
### `Host`
15
+
### Host
16
16
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.
18
18
19
-
**Responsibilities:**
19
+
#### Responsibilities
20
20
21
21
- Provide the server infrastructure (self-hosted or rented).
22
+
- Apply hypervisor security updates if relevant.
22
23
- Guarantee reliable internet connectivity for the server to fetch terms.
23
24
24
25
---
25
26
26
-
### `Administrator`
27
+
### Administrator
27
28
28
29
Manages the technical operation of the collection's software, ensuring it runs smoothly, stays updated, and remains secure.
29
30
30
-
**Responsibilities:**
31
+
#### Responsibilities
31
32
32
-
- Keep the engine operational.
33
-
- Ensure terms are tracked.
33
+
- Ensure the engine runs at the specified schedule.
34
34
- 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.
37
37
38
38
---
39
39
40
-
### `Curator`
40
+
### Curator
41
41
42
42
Defines the collection's focus and ensures all included content aligns with that scope.
43
43
44
-
**Responsibilities:**
44
+
#### Responsibilities
45
45
46
46
- Clearly define the collection's scope.
47
47
- 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.
49
49
50
50
---
51
51
52
-
### `Maintainer`
52
+
### Maintainer
53
53
54
54
Guarantees the integrity and quality of the collection's data by reviewing incoming contributions.
55
55
56
-
**Responsibilities:**
56
+
#### Responsibilities
57
57
58
58
- 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).
60
60
61
61
---
62
62
63
-
### `Contributor`
63
+
### Contributor
64
64
65
-
Actively adds new service information and keeps existing entries current.
65
+
Updates terms tracking and adds new entries.
66
66
67
-
**Responsibilities:**
67
+
#### Responsibilities
68
68
69
69
- Add service declarations.
70
70
- Keep service declarations up to date.
71
71
72
72
---
73
73
74
-
### `Sponsor`
74
+
### Sponsor
75
75
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.
77
77
78
-
**Responsibilities:**
78
+
#### Responsibilities
79
79
80
-
- Provide funding for collection operations.
81
-
- Provide agent time for other roles.
80
+
- Provide funding or in-kind contributions for collection operations.
82
81
- Provide political or institutional support.
83
82
- Make other relevant non-operational contributions.
Copy file name to clipboardExpand all lines: content/collections/reference/status.md
+14-20Lines changed: 14 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,38 +5,32 @@ weight: 5
5
5
6
6
# Collection status
7
7
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.
9
9
10
-
### `Active`
10
+
### Active
11
11
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.
15
13
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.
16
15
- 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.
19
17
20
18
---
21
19
22
-
### `Abandoned`
23
-
24
-
- Collection may be functional but shows clear signs of neglect.
20
+
### Abandoned
25
21
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.
27
23
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.
28
25
- 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.
31
27
32
28
---
33
29
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
39
31
40
-
- No technical maintenance is performed as the collection is no longer operational.
32
+
Collection has voluntarily ceased all operational activities.
41
33
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