Skip to content

Commit b63f1bd

Browse files
authored
Correct mistakes in metadata documentation (#157)
2 parents dc62acc + a93abc6 commit b63f1bd

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

content/collections/metadata.en.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ A collection is defined by the following metadata.
1414
| `name` | string | Display name of the collection (max 3 words) |
1515
| `id` | string | Unique identifier derived from name (acronyms, dash-separated) |
1616
| `tagline` | string | Concise description of collection topic |
17-
| `description` | string | Detailed context beyond tagline |
1817
| `languages` | Array of strings| [ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection |
1918
| `jurisdictions`| Array of strings| [ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions |
2019

@@ -41,7 +40,7 @@ Additional fields are optional but highly recommended to facilitate better disco
4140
| `snapshots` | url | URL to snapshots repository |
4241
| `logo` | url | URL to the collection's logo. Optimized PNG transparent image (min width 240px) |
4342
| `donation` | url | URL to donation page |
44-
| `trackingPeriods`| tracking periods object | see [Tracking periods](#tracking-periods) section |
43+
| `trackingPeriods`| array of tracking periods objects | see [Tracking periods](#tracking-periods) section |
4544
| `governance` | governance object | see [Governance](#governance) section |
4645

4746
Example:
@@ -71,10 +70,10 @@ Example:
7170

7271
```yaml
7372
trackingPeriods:
74-
startDate: 2023-01-01
75-
endDate: 2024-12-31
76-
schedule: "0 0 * * *"
77-
serverLocation: London, GB
73+
- startDate: 2023-01-01
74+
endDate: 2024-12-31
75+
schedule: "0 0 * * *"
76+
serverLocation: London, GB
7877
```
7978

8079
### Governance
@@ -127,10 +126,10 @@ donation: https://opencollective.com/opentermsarchive
127126
languages: [en]
128127
jurisdictions: [EU]
129128
trackingPeriods:
130-
startDate: 2023-01-01
131-
endDate: 2024-12-31
132-
schedule: "0 0 * * *"
133-
serverLocation: London, GB
129+
- startDate: 2023-01-01
130+
endDate: 2024-12-31
131+
schedule: "0 0 * * *"
132+
serverLocation: London, GB
134133
governance:
135134
hosts:
136135
- name: Ministry for Europe and Foreign Affairs

0 commit comments

Comments
 (0)