Skip to content

Commit 762bfd0

Browse files
committed
Update roles reference
1 parent bb1be46 commit 762bfd0

File tree

7 files changed

+200
-88
lines changed

7 files changed

+200
-88
lines changed

content/collections/how-to/create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ You can inform the community by posting on the instant messaging system, or [sen
2525

2626
## Define governance
2727

28-
Setting up and maintaining a collection over time needs fulfilling certain tasks on a regular basis. These tasks are handled through roles. To make sure that all these roles are covered, define the [governance]({{< relref "collections/reference/governance" >}}) of your collection.
28+
Setting up and maintaining a collection over time needs fulfilling certain tasks on a regular basis. These tasks are handled through roles. To make sure that all these roles are covered, define the [governance]({{< relref "collections/reference/roles" >}}) of your collection.
2929

3030
At any time, feel free to ask for help or partners in the community.
3131

content/collections/reference/governance.md

Lines changed: 0 additions & 82 deletions
This file was deleted.

content/collections/reference/metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ fr:
207207
{{< refItem
208208
name="roles"
209209
type="array of strings"
210-
description="Roles of the entity within the governance, see [collection governance](https://docs.opentermsarchive.org/collections/reference/governance/)"
210+
description="Roles of the entity within the governance, see [collection governance](https://docs.opentermsarchive.org/collections/reference/roles/)"
211211
allowedValues="host, administrator, curator, maintainer, sponsor"
212212
example="[host, administrator]"
213213
required=true
Lines changed: 185 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,185 @@
1+
---
2+
title: Collection roles reference
3+
linkTitle: Roles
4+
weight: 1
5+
aliases:
6+
- /collections/governance/
7+
- /collections/reference/roles/
8+
---
9+
10+
# Collection roles reference
11+
12+
A collection in Open Terms Archive is a set of tracked terms from various services, organized around a specific purpose or theme. This document outlines the different roles involved in operating and maintaining a collection.
13+
14+
Each role represents a set of responsibilities and tasks that contribute to the collection's success. A role can be filled by one or multiple people, and one person can fulfill multiple roles. All roles can be either volunteer or paid positions, depending on the collection's resources and needs.
15+
16+
This reference guide serves as a practical tool for collection organizers. It helps them understand the different roles needed for a collection, assign responsibilities effectively, ensure all necessary tasks are covered, and plan for long-term sustainability.
17+
18+
## Roles
19+
20+
### Host
21+
22+
Ensures the availability of the infrastructure required for the collection's operation.
23+
24+
#### Responsibilities
25+
26+
- Maintain reliable and secure infrastructure for collection operations
27+
- Ensure infrastructure meets technical requirements for collection operation
28+
- Provide necessary access and documentation for system administration
29+
30+
#### Tasks
31+
32+
- Set up and maintain server infrastructure (self-hosted or rented)
33+
- Implement and maintain security measures
34+
- Configure server for required outbound requests
35+
- Provide server access credentials to administrator
36+
- Document access procedures
37+
- Perform regular server maintenance
38+
- Coordinate maintenance windows with administrator
39+
40+
---
41+
42+
### System administrator (sysadmin)
43+
44+
Manages the technical operation of the collection's engine, ensuring it runs smoothly, stays updated, and remains secure.
45+
46+
#### Responsibilities
47+
48+
- Maintain reliable and secure operation of collection engine
49+
- Ensure timely and accurate terms publication
50+
- Keep collection engine and server up-to-date and secure
51+
52+
#### Tasks
53+
54+
- Update and maintain collection configuration files (metadata, deployment, engine)
55+
- Update Open Terms Archive engine and deployment system
56+
- Monitor and restart engine if needed
57+
- Investigate and resolve technical issues through log analysis
58+
- Verify regular updates of snapshots, versions, and datasets
59+
- Report bugs and suggest improvements to engine repository
60+
61+
---
62+
63+
### Curator
64+
65+
Defines the purpose of the collection, defines its boundaries and ensures all included content aligns with that purpose.
66+
67+
#### Responsibilities
68+
69+
- Define and maintain collection's strategic direction
70+
- Ensure collection content aligns with defined purpose
71+
- Guide collection's evolution and growth
72+
73+
#### Tasks
74+
75+
- Define and document collection scope
76+
- Review and approve scope changes
77+
- Communicate scope decisions to maintainers and contributors
78+
- Evaluate collection's alignment with purpose
79+
80+
---
81+
82+
### Maintainer
83+
84+
Ensures the integrity, quality, and accuracy of the collection's terms while managing community contributions.
85+
86+
#### Responsibilities
87+
88+
- Ensure quality and accuracy of collection terms
89+
- Manage and facilitate community contributions
90+
- Maintain quality of tracked terms
91+
92+
#### Tasks
93+
94+
- Review and validate new service declarations
95+
- Verify service declarations against scope criteria
96+
- Check service names match official branding
97+
- Validate completeness of extracted terms
98+
- Manage repository issues and pull requests
99+
- Provide feedback to contributors
100+
- Report issues to system administrator
101+
- Suggest scope improvements to curator
102+
- Report issues on the engine repository
103+
104+
---
105+
106+
### Contributor
107+
108+
Expands and maintains the collection's coverage by contributing and updating service terms within the defined scope.
109+
110+
#### Responsibilities
111+
112+
- Expand collection coverage within defined scope
113+
- Maintain accuracy of service declarations
114+
- Support collection's growth and quality
115+
116+
#### Tasks
117+
118+
- Research and identify new services to track
119+
- Create and update service declarations
120+
- Verify terms URLs and accessibility
121+
- Validate terms selection and extraction
122+
- Report issues to maintainers
123+
- Update outdated service information
124+
- Report issues on the engine repository
125+
126+
---
127+
128+
### Sponsor
129+
130+
Provides non-operational support such as funding or resources to facilitate the collection's success.
131+
132+
#### Responsibilities
133+
134+
- Ensure long-term financial sustainability
135+
- Provide necessary resources for operations
136+
- Enhance collection's reputation and reach
137+
138+
#### Tasks
139+
140+
- Provide and manage funding
141+
- Allocate required resources
142+
- Support collection promotion
143+
- Leverage network for visibility
144+
- Advocate for collection adoption
145+
146+
---
147+
148+
### Analyst
149+
150+
Analyzes terms changes to identify significant modifications and produce actionable insights.
151+
152+
#### Responsibilities
153+
154+
- Identify and analyze meaningful terms changes
155+
- Produce insights from changes
156+
157+
#### Tasks
158+
159+
- Monitor and review terms changes
160+
- Identify significant modifications
161+
- Write detailed analysis reports
162+
- Create regular digest reports
163+
- Flag critical changes to maintainers
164+
- Provide analysis materials to diffusers
165+
- Report issues affecting analysis
166+
167+
---
168+
169+
### Diffuser
170+
171+
Promotes collection and disseminates analysis to relevant audiences.
172+
173+
#### Responsibilities
174+
175+
- Maximize collection visibility and impact
176+
- Ensure effective communication of findings
177+
- Build and grow collection's community
178+
179+
#### Tasks
180+
181+
- Create and manage communication channels
182+
- Publish and distribute analysis reports
183+
- Maintain social media presence
184+
- Track communication metrics
185+
- Engage with community

content/collections/reference/status.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The optimal operational state for a collection.
1313

1414
- 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.
1515
- Technical maintenance includes regular dependency updates, access to the latest engine features, and benefits from all infrastructure updates.
16-
- All [roles]({{< relref "collections/reference/governance" >}}) are fulfilled.
16+
- All [roles]({{< relref "collections/reference/roles" >}}) are fulfilled.
1717

1818
---
1919

@@ -23,7 +23,7 @@ Collection may be functional but shows clear signs of neglect.
2323

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

2828
---
2929

@@ -33,4 +33,4 @@ Collection has voluntarily ceased all operational activities.
3333

3434
- No terms are tracked anymore, though historical records remain accessible for reference purposes.
3535
- No technical maintenance is performed.
36-
- All [roles]({{< relref "collections/reference/governance" >}}) are inactive.
36+
- All [roles]({{< relref "collections/reference/roles" >}}) are inactive.

content/federation/reference/criteria.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 3
88
A **collection** can **join** the Open Terms Archive **federation** if it abides by the following quality criteria:
99

1010
1. Clearly defined [collection metadata]({{< relref "collections/reference/metadata" >}}).
11-
2. Clearly defined [collection governance]({{< relref "collections/reference/governance" >}}).
11+
2. Clearly defined [collection governance]({{< relref "collections/reference/roles" >}}).
1212
3. The vast majority of **versions** are readable, as evidenced by a sample assessment.
1313
4. **Frequency** of at least one track a day, as evidenced by snapshots.
1414
5. Public and open-licensed **declarations**, as evidenced by the `LICENSE` file in the declarations repository.

docs/ota-tracking.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# OTA tracking investigation
2+
3+
## Overview
4+
5+
This document analyzes the tracking behavior of various OTA (Online Travel Agency) services, focusing on services that implement bot detection.
6+
7+
## Tracking logs
8+
9+
I've included a representative sample of tracking logs from the bot-blocked services. While I didn't save every log, the collected data provides sufficient evidence for our analysis. I focused testing on the bot-blocked services to optimize the investigation time.

0 commit comments

Comments
 (0)