Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/collections/how-to/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You can inform the community by posting on the instant messaging system, or [sen

## Define governance

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.
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.

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

Expand Down
82 changes: 0 additions & 82 deletions content/collections/reference/governance.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/collections/reference/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ fr:
{{< refItem
name="roles"
type="array of strings"
description="Roles of the entity within the governance, see [collection governance](https://docs.opentermsarchive.org/collections/reference/governance/)"
description="Roles of the entity within the governance, see [collection governance](https://docs.opentermsarchive.org/collections/reference/roles/)"
allowedValues="host, administrator, curator, maintainer, sponsor"
example="[host, administrator]"
required=true
Expand Down
185 changes: 185 additions & 0 deletions content/collections/reference/roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
---
title: Collection roles reference
linkTitle: Roles
weight: 1
aliases:
- /collections/governance/
- /collections/reference/roles/
---

# Collection roles reference

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.

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.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's avoid introducing the notion of “collection organizers”, which sounds like a role in itself 🙂

Suggested change
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.
This reference guide helps understand the different roles needed for a collection, assign responsibilities effectively, ensure all necessary tasks are covered, and plan for long-term sustainability.

I'm not sure of the added value of this introductory section.


## Roles

### Host

Ensures the availability of the infrastructure required for the collection's operation.

#### Responsibilities

- Maintain reliable and secure infrastructure for collection operations
- Ensure infrastructure meets technical requirements for collection operation
- Provide necessary access and documentation for system administration

#### Tasks

- Set up and maintain server infrastructure (self-hosted or rented)
- Implement and maintain security measures
- Configure server for required outbound requests
- Provide server access credentials to administrator
- Document access procedures
- Perform regular server maintenance
- Coordinate maintenance windows with administrator

---

### System administrator (sysadmin)

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

#### Responsibilities

- Maintain reliable and secure operation of collection engine
- Ensure timely and accurate terms publication
- Keep collection engine and server up-to-date and secure

#### Tasks

- Update and maintain collection configuration files (metadata, deployment, engine)
- Update Open Terms Archive engine and deployment system
- Monitor and restart engine if needed
- Investigate and resolve technical issues through log analysis
- Verify regular updates of snapshots, versions, and datasets
- Report bugs and suggest improvements to engine repository

---

### Curator

Defines the purpose of the collection, defines its boundaries and ensures all included content aligns with that purpose.

#### Responsibilities

- Define and maintain collection's strategic direction
- Ensure collection content aligns with defined purpose
- Guide collection's evolution and growth

#### Tasks

- Define and document collection scope
- Review and approve scope changes
- Communicate scope decisions to maintainers and contributors
- Evaluate collection's alignment with purpose

---

### Maintainer

Ensures the integrity, quality, and accuracy of the collection's terms while managing community contributions.

#### Responsibilities

- Ensure quality and accuracy of collection terms
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What would the “accuracy” be in this context?

Suggested change
- Ensure quality and accuracy of collection terms
- Ensure quality of collection terms

- Manage and facilitate community contributions
- Maintain quality of tracked terms

#### Tasks

- Review and validate new service declarations
- Verify service declarations against scope criteria
- Check service names match official branding
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's broaden that to following Open Terms Archive guidelines, not only on service names (there is also the ID, filters, history…).

- Validate completeness of extracted terms
- Manage repository issues and pull requests
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we be more specific than “manage”? What do expect of them exactly?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how to be more specific here, there are many different tasks involved, and I’d prefer not to try to list them to avoid leaving anything out (e.g., reviewing/merging/rejecting PRs, responding to contributors, closing irrelevant issues, …).
Do you think it would be better to remove this entirely rather than leave it as-is?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe:

Suggested change
- Manage repository issues and pull requests
- Facilitate discussions in issues and pull requests

?

- Provide feedback to contributors
- Report issues to system administrator
- Suggest scope improvements to curator
- Report issues on the engine repository
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe merge the different reporting duties into a single point (“Refer issues identified in contributions to the most relevant actor (scope conflicts to curator, tracking issues to system administrator, bugs to the core team…)”)?


---

### Contributor

Expands and maintains the collection's coverage by contributing and updating service terms within the defined scope.

#### Responsibilities

- Expand collection coverage within defined scope
- Maintain accuracy of service declarations
- Support collection's growth and quality

#### Tasks

- Research and identify new services to track
- Create and update service declarations
- Verify terms URLs and accessibility
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not clear to me.

- Validate terms selection and extraction
- Report issues to maintainers
- Update outdated service information
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Redundant.

Suggested change
- Update outdated service information

- Report issues on the engine repository
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit ambitious to me. Maybe on the contribution tool? Or just “to the core team”? Or not at all?


---

### Sponsor

Provides non-operational support such as funding or resources to facilitate the collection's success.

#### Responsibilities

- Ensure long-term financial sustainability
- Provide necessary resources for operations
- Enhance collection's reputation and reach

#### Tasks

- Provide and manage funding
- Allocate required resources
- Support collection promotion
- Leverage network for visibility
- Advocate for collection adoption

---

### Analyst

Analyzes terms changes to identify significant modifications and produce actionable insights.

#### Responsibilities

- Identify and analyze meaningful terms changes
- Produce insights from changes

#### Tasks

- Monitor and review terms changes
- Identify significant modifications
- Write detailed analysis reports
- Create regular digest reports
- Flag critical changes to maintainers
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why? What is “critical”?

- Provide analysis materials to diffusers
- Report issues affecting analysis
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To whom? Maybe merge this with reporting to maintainers above 🙂


---

### Diffuser

Promotes collection and disseminates analysis to relevant audiences.

#### Responsibilities

- Maximize collection visibility and impact
- Ensure effective communication of findings
- Build and grow collection's community

#### Tasks

- Create and manage communication channels
- Publish and distribute analysis reports
- Maintain social media presence
- Track communication metrics
- Engage with community
6 changes: 3 additions & 3 deletions content/collections/reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The optimal operational state for a collection.

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

---

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

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

---

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

- No terms are tracked anymore, though historical records remain accessible for reference purposes.
- No technical maintenance is performed.
- All [roles]({{< relref "collections/reference/governance" >}}) are inactive.
- All [roles]({{< relref "collections/reference/roles" >}}) are inactive.
2 changes: 1 addition & 1 deletion content/federation/reference/criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ weight: 3
A **collection** can **join** the Open Terms Archive **federation** if it abides by the following quality criteria:

1. Clearly defined [collection metadata]({{< relref "collections/reference/metadata" >}}).
2. Clearly defined [collection governance]({{< relref "collections/reference/governance" >}}).
2. Clearly defined [collection governance]({{< relref "collections/reference/roles" >}}).
3. The vast majority of **versions** are readable, as evidenced by a sample assessment.
4. **Frequency** of at least one track a day, as evidenced by snapshots.
5. Public and open-licensed **declarations**, as evidenced by the `LICENSE` file in the declarations repository.
Expand Down
9 changes: 9 additions & 0 deletions docs/ota-tracking.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be here? 🤔

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# OTA tracking investigation

## Overview

This document analyzes the tracking behavior of various OTA (Online Travel Agency) services, focusing on services that implement bot detection.

## Tracking logs

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.