Skip to content

Commit 608289d

Browse files
committed
Improve metadata page
1 parent 3942e66 commit 608289d

File tree

1 file changed

+37
-32
lines changed

1 file changed

+37
-32
lines changed

content/collections/metadata.en.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ weight: 1
55

66
# Collection metadata
77

8-
A collection is defined by its scope, which includes various dimensions such as language, jurisdiction, and industry. To accurately describe this scope, the following metadata fields are required: `id`, `name`, `tagline`, `languages`, and `jurisdictions`. Additional fields are optional but highly recommended to facilitate better discovery, comprehension, management, and utilization.
8+
A collection is defined by the following metadata.
99

10-
Below is the list of all metadata fields:
10+
## Required fields
1111

1212
| Field | Type | Description |
1313
|----------------|-----------------|---------------------------------------|
@@ -17,34 +17,43 @@ Below is the list of all metadata fields:
1717
| `description` | string | Detailed context beyond tagline |
1818
| `languages` | Array of strings| ISO 639 language codes allowed in collection |
1919
| `jurisdictions`| Array of strings| ISO 3166-2 country codes for covered jurisdictions |
20-
| `trackingPeriods`| object | Information about tracking schedule |
20+
21+
Example:
22+
23+
```yaml
24+
name: Platform Governance Archive
25+
id: pga
26+
tagline: Largest global social media
27+
languages: [en, fr, de]
28+
jurisdictions: [EU]
29+
```
30+
31+
## Additional fields
32+
33+
Additional fields are optional but highly recommended to facilitate better discovery, comprehension, and utilization of the collection.
34+
35+
| Field | Type | Description |
36+
|----------------|-----------------|---------------------------------------|
37+
| `description` | string | Detailed context beyond tagline |
2138
| `dataset` | url | URL to released versions dataset |
2239
| `declarations` | url | URL to declarations repository |
2340
| `versions` | url | URL to versions repository |
2441
| `snapshots` | url | URL to snapshots repository |
25-
| `logo` | url | URL to collection logo |
26-
| `governance` | object | Governance information |
42+
| `logo` | url | URL to the collection's logo. Optimized PNG transparent image (min size 240px) |
2743
| `donation` | url | URL to donation page |
44+
| `trackingPeriods`| tracking periods object | see [Tracking periods](#tracking-periods) section |
45+
| `governance` | governance object | see [Governance](#governance) section |
2846

2947
Example:
3048

3149
```yaml
32-
name: Platform Governance Archive
33-
id: pga
34-
tagline: Largest global social media
3550
description: Comprehensive collection of terms of service from major global social media platforms.
36-
languages:
37-
- en
38-
- fr
39-
- de
40-
jurisdictions:
41-
- EU
4251
dataset: https://github.com/OpenTermsArchive/demo-versions/releases
4352
declarations: https://github.com/OpenTermsArchive/demo-declarations
4453
versions: https://github.com/OpenTermsArchive/demo-versions
4554
snapshots: https://github.com/OpenTermsArchive/demo-snapshots
4655
logo: https://opentermsarchive.org/images/collections/demo.png
47-
donation: https://opentermsarchive.org/donate
56+
donation: https://opencollective.com/opentermsarchive
4857
```
4958

5059
## Tracking periods
@@ -53,10 +62,10 @@ Information about when and how terms are tracked:
5362

5463
| Field | Type | Description |
5564
|---------------|--------|--------------------------------------------|
56-
| `startDate` | date | Date when tracking began |
57-
| `endDate` | date | Date when tracking ended/will end. No end date means tracking is ongoing. |
58-
| `schedule` | string | Cron expression defining tracking frequency |
59-
| `serverLocation`| string| Geographic location of tracking server |
65+
| `startDate` | date (ISO 8601 format: YYYY-MM-DD) | The date when tracking started |
66+
| `endDate` | date (ISO 8601 format: YYYY-MM-DD) | The date when tracking ended or will end. If not specified, tracking is ongoing. |
67+
| `schedule` | string | A [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) that defines the tracking frequency |
68+
| `serverLocation`| string (city name, ISO 3166-2 country code) | The geographic location of the tracking server |
6069

6170
Example:
6271

@@ -74,21 +83,19 @@ Organizations responsible for collection roles:
7483

7584
| Field | Type | Description |
7685
|---------------|-----------------|----------------------------------------|
77-
| `hosts` | Array of objects| Organizations hosting the collection |
78-
| `administrators`| Array of objects| Organizations managing the collection |
79-
| `curators` | Array of objects| Organizations curating the content |
80-
| `maintainers` | Array of objects| Organizations maintaining the technical aspects |
81-
| `sponsors` | Array of objects| Organizations providing support |
82-
83-
## Organization
86+
| `hosts` | Array of organizations objects| Organizations hosting the collection |
87+
| `administrators`| Array of organizations objects| Organizations managing the collection |
88+
| `curators` | Array of organizations objects| Organizations curating the content |
89+
| `maintainers` | Array of organizations objects| Organizations maintaining the technical aspects |
90+
| `sponsors` | Array of organizations objects| Organizations providing support |
8491

8592
Each organization in the governance roles is defined by the following fields:
8693

8794
| Field | Type | Description |
8895
|---------------|--------|-------------------------------------------|
8996
| `name` | string | Name of the organization |
90-
| `url` | url | Website URL of the organization |
91-
| `logo` | url | URL to the organization's logo |
97+
| `url` | url | Website URL of the organization (optional) |
98+
| `logo` | url | URL to the organization's logo. Optimized PNG transparent image (min size 240px) (optional) |
9299

93100
Example:
94101

@@ -117,10 +124,8 @@ versions: https://github.com/OpenTermsArchive/demo-versions
117124
snapshots: https://github.com/OpenTermsArchive/demo-snapshots
118125
logo: https://opentermsarchive.org/images/collections/demo.png
119126
donation: https://opentermsarchive.org/donate
120-
languages:
121-
- en
122-
jurisdictions:
123-
- EU
127+
languages: [en]
128+
jurisdictions: [EU]
124129
trackingPeriods:
125130
startDate: 2023-01-01
126131
endDate: 2024-12-31

0 commit comments

Comments
 (0)