diff --git a/content/collections/how-to/create.md b/content/collections/how-to/create.md index c48a4295..d471f386 100644 --- a/content/collections/how-to/create.md +++ b/content/collections/how-to/create.md @@ -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. diff --git a/content/collections/reference/governance.md b/content/collections/reference/governance.md deleted file mode 100644 index a53a1667..00000000 --- a/content/collections/reference/governance.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -title: Governance -weight: 1 -aliases: /collections/governance/ ---- - -# Collection governance - -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. - -This reference documentation details all roles that must be involved in a collection's governance to ensure its proper operation and maintenance. - -## Roles - -### Host - -Ensures the availability of the infrastructure required for the collection's operation. - -#### Responsibilities - -- Provide the server infrastructure (self-hosted or rented). -- Apply hypervisor security updates if relevant. -- Guarantee reliable internet connectivity for the server to fetch terms. - ---- - -### Administrator - -Manages the technical operation of the collection's software, ensuring it runs smoothly, stays updated, and remains secure. - -#### Responsibilities - -- Ensure the engine runs at the specified schedule. -- Ensure the public publishing of snapshots, versions, and datasets. -- Keep the engine and deployment systems up-to-date. -- Apply operating system security updates. - ---- - -### Curator - -Defines the collection's focus and ensures all included content aligns with that scope. - -#### Responsibilities - -- Clearly define the collection's scope. -- Make the collection scope publicly available via the metadata file. -- Verify that included services and terms match the defined scope. - ---- - -### Maintainer - -Guarantees the integrity and quality of the collection's data by reviewing incoming contributions. - -#### Responsibilities - -- Review contributions. -- Maintain the quality of tracked versions (e.g. removing noise, ensuring completeness). - ---- - -### Contributor - -Updates terms tracking and adds new entries. - -#### Responsibilities - -- Add service declarations. -- Keep service declarations up to date. - ---- - -### Sponsor - -Provides non-operational support such as funding or resources to facilitate the collection's success. - -#### Responsibilities - -- Provide funding or in-kind contributions for collection operations. -- Provide political or institutional support. -- Make other relevant non-operational contributions. diff --git a/content/collections/reference/metadata.md b/content/collections/reference/metadata.md index b124420a..41b7f742 100644 --- a/content/collections/reference/metadata.md +++ b/content/collections/reference/metadata.md @@ -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 diff --git a/content/collections/reference/roles.md b/content/collections/reference/roles.md new file mode 100644 index 00000000..0aac6725 --- /dev/null +++ b/content/collections/reference/roles.md @@ -0,0 +1,169 @@ +--- +title: Collection roles reference +linkTitle: Roles +weight: 1 +aliases: + - /collections/governance/ + - /collections/reference/roles/ +--- + +# Collection roles reference + +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 or organisations, and one entity can fulfill multiple roles. All roles can be either volunteer or paid positions, depending on the collection’s resources and needs. + +## 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 +- 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 +- Ensure that snapshots, versions and datasets are published +- Report bugs and suggest improvements to engine repository + +--- + +### Curator + +Defines the purpose and scope of the collection and ensures all included content aligns with it. + +#### Responsibilities + +- Define and maintain the collection’s strategic direction +- Ensure collection content aligns with defined purpose + +#### Tasks + +- Define and document collection scope +- Define and document level of openness to third-party contributions +- Answer any questions related to scope that emerge from maintainers and contributors +- Communicate scope updates to maintainers and contributors +- Ensure collection’s alignment with original purpose + +--- + +### Maintainer + +Ensures the integrity, quality, and accuracy of the collection’s terms. Manages incoming contributions. + +#### Responsibilities + +- Ensure quality of collection terms +- Manage and facilitate contributions + +#### Tasks + +- Review and validate new service declarations +- Verify service declarations against scope criteria +- Ensure service declarations follow Open Terms Archive guidelines (service names, service IDs, terms types, filters, history, …) +- Validate completeness of extracted terms +- Facilitate discussions in issues and pull requests +- Provide feedback to contributors +- 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 +- Report issues affecting contributions to maintainers + +--- + +### Analyst + +Analyses terms changes to identify significant changes and produce reports in various formats. + +#### Responsibilities + +- Identify and analyze meaningful terms changes +- Produce insights from changes + +#### Tasks + +- Monitor and review terms changes +- Identify significant changes +- Produce reports +- Report issues affecting analysis to maintainers + +--- + +### 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 + +--- + +### 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 +- Support collection promotion +- Leverage network for visibility +- Advocate for collection adoption diff --git a/content/collections/reference/status.md b/content/collections/reference/status.md index a06a67e3..8684e6b3 100644 --- a/content/collections/reference/status.md +++ b/content/collections/reference/status.md @@ -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. --- @@ -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. --- @@ -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. diff --git a/content/federation/reference/criteria.md b/content/federation/reference/criteria.md index a4c5a831..15f31ab6 100644 --- a/content/federation/reference/criteria.md +++ b/content/federation/reference/criteria.md @@ -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.