Skip to content

Commit 73d395a

Browse files
committed
Update metadata reference
1 parent 6e68318 commit 73d395a

File tree

1 file changed

+30
-71
lines changed

1 file changed

+30
-71
lines changed

content/collections/reference/metadata.en.md

Lines changed: 30 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,45 @@ weight: 1
55

66
# Collection metadata
77

8-
A collection is defined by the following metadata.
8+
This reference documentation details all available metadata fields that can be specified in a collection's metadata file.
99

10-
## Required fields
10+
## Fields
1111

12-
{{< configOption name="name" type="string" description="Display name of the collection (max 3 words)" example="Platform Governance Archive" >}}
12+
{{< configOption name="id" type="string" description="Unique identifier derived from name (acronyms, dash-separated)" example="pga" required=true >}}
1313

14-
{{< configOption name="id" type="string" description="Unique identifier derived from name (acronyms, dash-separated)" example="pga" >}}
14+
{{< configOption name="name" type="string" description="Display name of the collection (max 3 words)" example="Platform Governance Archive" required=true >}}
1515

16-
{{< configOption name="tagline" type="string" description="Concise description of collection topic" example="Largest global social media" >}}
16+
{{< configOption name="tagline" type="string" description="Concise description of collection topic" example="Major global social media services" required=true >}}
1717

18-
{{< configOption name="languages" type="Array of strings" description="[ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection" example="[en, fr, de]" >}}
18+
{{< configOption name="languages" type="Array of strings" description="[ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection" example="[en, fr, de]" required=true >}}
1919

20-
{{< configOption name="jurisdictions" type="Array of strings" description="[ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions" example="[EU]" >}}
20+
{{< configOption name="jurisdictions" type="Array of strings" description="[ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions" example="[EU]" required=true >}}
2121

22-
## Additional fields
22+
{{< configOption name="description" type="string" description="Detailed description of the collection" example=`The **Platform Governance Archive** (PGA) collection tracks the terms of major global social media services.
2323

24-
{{< configOption name="description" type="string" description="Detailed context beyond tagline" example="Comprehensive collection of terms of service from major global social media platforms." >}}
24+
This data is maintained and analysed by the [Platform Governance Archive](https://www.platformgovernancearchive.org/) at the Universität Bremen's [Center for Media Communication and Information Research (ZeMKI)](https://www.uni-bremen.de/zemki).
2525

26-
{{< configOption name="dataset" type="url" description="URL to released versions dataset" example="https://github.com/OpenTermsArchive/demo-versions/releases" >}}
26+
This initiative offers researchers, journalists and citizens the tools to analyze how platforms structure and regulate communication and interaction in our societies.
2727

28-
{{< configOption name="declarations" type="url" description="URL to declarations repository" example="https://github.com/OpenTermsArchive/demo-declarations" >}}
28+
It also aims to promote greater transparency and accountability of these powerful digital services.` >}}
29+
30+
{{< configOption name="dataset" type="url" description="URL to released versions dataset" example="https://github.com/OpenTermsArchive/pga-versions/releases" >}}
2931

30-
{{< configOption name="versions" type="url" description="URL to versions repository" example="https://github.com/OpenTermsArchive/demo-versions" >}}
32+
{{< configOption name="declarations" type="url" description="URL to declarations repository" example="https://github.com/OpenTermsArchive/pga-declarations" >}}
3133

32-
{{< configOption name="snapshots" type="url" description="URL to snapshots repository" example="https://github.com/OpenTermsArchive/demo-snapshots" >}}
34+
{{< configOption name="versions" type="url" description="URL to versions repository" example="https://github.com/OpenTermsArchive/pga-versions" >}}
3335

34-
{{< configOption name="logo" type="url" description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)" example="https://opentermsarchive.org/images/collections/demo.png" >}}
36+
{{< configOption name="snapshots" type="url" description="URL to snapshots repository" example="https://github.com/OpenTermsArchive/pga-snapshots" >}}
3537

36-
{{< configOption name="donation" type="url" description="URL to donation page" example="https://opencollective.com/opentermsarchive" >}}
38+
{{< configOption name="logo" type="url" description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)" example="https://opentermsarchive.org/images/collections/pga.png" >}}
3739

38-
{{< configOption name="trackingPeriods" type="array of tracking periods objects" description="see [Tracking periods](#tracking-periods) section" >}}
40+
{{< configOption name="donations" type="url" description="URL to the donations page" example="https://opencollective.com/opentermsarchive" >}}
3941

40-
{{< configOption name="governance" type="governance object" description="see [Governance](#governance) section" >}}
42+
{{< configOption name="trackingPeriods" type="array of tracking periods objects" description="Tracking periods object, see [Tracking periods](#tracking-periods) section" >}}
43+
44+
{{< configOption name="governance" type="array of entity objects" description="Entity object, see [Entity](#entity) section" >}}
45+
46+
---
4147

4248
### Tracking periods
4349

@@ -49,65 +55,18 @@ A collection is defined by the following metadata.
4955

5056
{{< configOption name="serverLocation" type="string" description="The geographic location of the tracking server (city name, ISO 3166-2 country code)" example="London, GB" >}}
5157

52-
### Governance
53-
54-
{{< configOption name="hosts" type="Array of organizations objects" description="Organizations hosting the collection" >}}
55-
56-
{{< configOption name="administrators" type="Array of organizations objects" description="Organizations managing the collection" >}}
57-
58-
{{< configOption name="curators" type="Array of organizations objects" description="Organizations curating the content" >}}
59-
60-
{{< configOption name="maintainers" type="Array of organizations objects" description="Organizations maintaining the technical aspects" >}}
61-
62-
{{< configOption name="sponsors" type="Array of organizations objects" description="Organizations providing support" >}}
58+
---
6359

64-
Each organization in the governance roles is defined by the following fields:
60+
### Entity
6561

6662
{{< configOption name="name" type="string" description="Name of the organization" example="Open Terms Archive" >}}
6763

6864
{{< configOption name="url" type="url" description="Website URL of the organization (optional)" example="https://opentermsarchive.org/" >}}
6965

7066
{{< configOption name="logo" type="url" description="URL to the organization's logo. Optimized PNG transparent image (min width 240px) (optional)" example="https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png" >}}
7167

72-
## Complete metadata example
73-
74-
```yaml
75-
id: demo
76-
name: Demo
77-
tagline: Services needed to operate the Open Terms Archive engine
78-
description: This demo collection serves as a reference implementation…
79-
dataset: https://github.com/OpenTermsArchive/demo-versions/releases
80-
declarations: https://github.com/OpenTermsArchive/demo-declarations
81-
versions: https://github.com/OpenTermsArchive/demo-versions
82-
snapshots: https://github.com/OpenTermsArchive/demo-snapshots
83-
logo: https://opentermsarchive.org/images/collections/demo.png
84-
donation: https://opencollective.com/opentermsarchive
85-
languages: [en]
86-
jurisdictions: [EU]
87-
trackingPeriods:
88-
- startDate: 2023-01-01
89-
endDate: 2024-12-31
90-
schedule: "0 0 * * *"
91-
serverLocation: London, GB
92-
governance:
93-
hosts:
94-
- name: Ministry for Europe and Foreign Affairs
95-
url: https://www.diplomatie.gouv.fr/en/
96-
logo: https://opentermsarchive.org/images/contributors/meae.png
97-
administrators:
98-
- name: Open Terms Archive
99-
url: https://opentermsarchive.org/
100-
logo: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png
101-
curators:
102-
- name: Open Terms Archive
103-
url: https://opentermsarchive.org/
104-
logo: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png
105-
maintainers:
106-
- name: Open Terms Archive
107-
url: https://opentermsarchive.org/
108-
logo: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png
109-
sponsors:
110-
- name: Ministry for Europe and Foreign Affairs
111-
url: https://www.diplomatie.gouv.fr/en/
112-
logo: https://opentermsarchive.org/images/contributors/meae.png
113-
```
68+
{{< configOption name="roles" type="string" description="Roles of the entity within the governance" allowedValues="host, administrator, curator, maintainer, sponsor" >}}
69+
70+
---
71+
72+
As an example, see the [complete metadata file](https://github.com/OpenTermsArchive/demo-declarations/blob/main/metadata.yml) of the [Demo collection](https://github.com/OpenTermsArchive/demo-declarations).

0 commit comments

Comments
 (0)