Skip to content

Commit 631e42a

Browse files
NdpntNdpnt
committed
Improve metadata page
1 parent 8f5cd0b commit 631e42a

File tree

1 file changed

+65
-43
lines changed

1 file changed

+65
-43
lines changed

‎content/collections/metadata.en.md‎

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

66
# Collection metadata
77

8-
A collection is defined by the following metadata fields:
9-
10-
| JSON Field | Type | Required | Description | Example |
11-
|------------|------|----------|-------------|---------|
12-
| `name` | string | ✓ | Display name of the collection (max 3 words) | Platform Governance Archive |
13-
| `id` | string | ✓ | Unique identifier derived from name (acronyms, dash-separated) | `pga` |
14-
| `tagline` | string | ✓ | Concise description of collection topic | Largest global social media |
15-
| `description` | string | - | Detailed context beyond tagline | Comprehensive collection of terms of service from major global social media platforms. |
16-
| `languages` | Array of strings | ✓ | ISO 639 language codes allowed in collection | `["en", "fr", "de"]` |
17-
| `jurisdictions` | Array of strings | ✓ | ISO 3166-2 country codes for covered jurisdictions | `["EU", "global"]` |
18-
| `trackingPeriods` | object | - | Information about tracking schedule | see [Tracking Periods](#tracking-periods) section |
19-
| `dataset` | url | - | URL to released versions dataset | `https://github.com/OpenTermsArchive/demo-versions/releases` |
20-
| `declarations` | url | - | URL to declarations repository | `https://github.com/OpenTermsArchive/demo-declarations` |
21-
| `versions` | url | - | URL to versions repository | `https://github.com/OpenTermsArchive/demo-versions` |
22-
| `snapshots` | url | - | URL to snapshots repository | `https://github.com/OpenTermsArchive/demo-snapshots` |
23-
| `logo` | url | - | URL to collection logo | `https://opentermsarchive.org/images/collections/demo.png` |
24-
| `governance` | object | - | Governance information | see [Governance](#governance) section |
25-
| `donation` | url | - | URL to donation page | `https://opentermsarchive.org/donate` |
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.
9+
10+
Below is the list of all metadata fields:
11+
12+
| Field | Type | Description |
13+
|----------------|-----------------|---------------------------------------|
14+
| `name` | string | Display name of the collection (max 3 words) |
15+
| `id` | string | Unique identifier derived from name (acronyms, dash-separated) |
16+
| `tagline` | string | Concise description of collection topic |
17+
| `description` | string | Detailed context beyond tagline |
18+
| `languages` | Array of strings| ISO 639 language codes allowed in collection |
19+
| `jurisdictions`| Array of strings| ISO 3166-2 country codes for covered jurisdictions |
20+
| `trackingPeriods`| object | Information about tracking schedule |
21+
| `dataset` | url | URL to released versions dataset |
22+
| `declarations` | url | URL to declarations repository |
23+
| `versions` | url | URL to versions repository |
24+
| `snapshots` | url | URL to snapshots repository |
25+
| `logo` | url | URL to collection logo |
26+
| `governance` | object | Governance information |
27+
| `donation` | url | URL to donation page |
28+
29+
Example:
30+
31+
```yaml
32+
name: Platform Governance Archive
33+
id: pga
34+
tagline: Largest global social media
35+
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
42+
dataset: https://github.com/OpenTermsArchive/demo-versions/releases
43+
declarations: https://github.com/OpenTermsArchive/demo-declarations
44+
versions: https://github.com/OpenTermsArchive/demo-versions
45+
snapshots: https://github.com/OpenTermsArchive/demo-snapshots
46+
logo: https://opentermsarchive.org/images/collections/demo.png
47+
donation: https://opentermsarchive.org/donate
48+
```
2649
2750
## Tracking periods
2851
2952
Information about when and how terms are tracked:
3053
31-
| JSON Field | Type | Required | Description | Example |
32-
|------------|------|----------|-------------|---------|
33-
| `startDate` | date | - | Date when tracking began | `2023-01-01` |
34-
| `endDate` | date | - | Date when tracking ended/will end. No end date means tracking is ongoing. | `2024-12-31` |
35-
| `schedule` | string | - | Cron expression defining tracking frequency | `0 0 * * *` (daily at midnight) |
36-
| `serverLocation` | string | - | Geographic location of tracking server | `London, GB` |
54+
| Field | Type | Description |
55+
|---------------|--------|--------------------------------------------|
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 |
3760

38-
**Example:**
61+
Example:
3962

4063
```yaml
4164
trackingPeriods:
@@ -49,25 +72,25 @@ trackingPeriods:
4972

5073
Organizations responsible for collection roles:
5174

52-
| JSON Field | Type | Required | Description | Example |
53-
|------------|------|----------|-------------|---------|
54-
| `hosts` | Array of objects | - | Organizations hosting the collection | see [Organization](#organization) section |
55-
| `administrators` | Array of objects | - | Organizations managing the collection | see [Organization](#organization) section |
56-
| `curators` | Array of objects | - | Organizations curating the content | see [Organization](#organization) section |
57-
| `maintainers` | Array of objects | - | Organizations maintaining the technical aspects | see [Organization](#organization) section |
58-
| `sponsors` | Array of objects | - | Organizations providing support | see [Organization](#organization) section |
75+
| Field | Type | Description |
76+
|---------------|-----------------|----------------------------------------|
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 |
5982

6083
## Organization
6184

6285
Each organization in the governance roles is defined by the following fields:
6386

64-
| JSON Field | Type | Required | Description | Example |
65-
|------------|------|----------|-------------|---------|
66-
| `name` | string | - | Name of the organization | `Open Terms Archive` |
67-
| `url` | url | - | Website URL of the organization | `https://opentermsarchive.org/` |
68-
| `logo` | url | - | URL to the organization's logo | `https://opentermsarchive.org/images/logo/logo.png` |
87+
| Field | Type | Description |
88+
|---------------|--------|-------------------------------------------|
89+
| `name` | string | Name of the organization |
90+
| `url` | url | Website URL of the organization |
91+
| `logo` | url | URL to the organization's logo |
6992

70-
**Example:**
93+
Example:
7194

7295
```yaml
7396
governance:
@@ -81,29 +104,28 @@ governance:
81104
sponsors: []
82105
```
83106

84-
**Complete metadata example:**
107+
## Complete metadata example
85108

86109
```yaml
87110
id: demo
88111
name: Demo
89112
tagline: Services needed to operate the Open Terms Archive engine
90-
description: This demo collection serves as a reference implementation...
113+
description: This demo collection serves as a reference implementation…
91114
dataset: https://github.com/OpenTermsArchive/demo-versions/releases
92115
declarations: https://github.com/OpenTermsArchive/demo-declarations
93116
versions: https://github.com/OpenTermsArchive/demo-versions
94117
snapshots: https://github.com/OpenTermsArchive/demo-snapshots
95118
logo: https://opentermsarchive.org/images/collections/demo.png
119+
donation: https://opentermsarchive.org/donate
96120
languages:
97121
- en
98122
jurisdictions:
99123
- EU
100-
termsTracked: 100
101-
servicesTracked: 50
102124
trackingPeriods:
103125
startDate: 2023-01-01
104126
endDate: 2024-12-31
105127
schedule: "0 0 * * *"
106-
serverLocation: EU-WEST-1
128+
serverLocation: London, GB
107129
governance:
108130
hosts:
109131
- name: Ministry for Europe and Foreign Affairs

0 commit comments

Comments
 (0)