Skip to content

Correct mistakes in metadata documentation #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Correct mistakes in metadata documentation #157

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions content/collections/metadata.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ A collection is defined by the following metadata.
| `name` | string | Display name of the collection (max 3 words) |
| `id` | string | Unique identifier derived from name (acronyms, dash-separated) |
| `tagline` | string | Concise description of collection topic |
| `description` | string | Detailed context beyond tagline |
| `languages` | Array of strings| [ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection |
| `jurisdictions`| Array of strings| [ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions |

Expand All @@ -41,7 +40,7 @@ Additional fields are optional but highly recommended to facilitate better disco
| `snapshots` | url | URL to snapshots repository |
| `logo` | url | URL to the collection's logo. Optimized PNG transparent image (min width 240px) |
| `donation` | url | URL to donation page |
| `trackingPeriods`| tracking periods object | see [Tracking periods](#tracking-periods) section |
| `trackingPeriods`| array of tracking periods objects | see [Tracking periods](#tracking-periods) section |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| `trackingPeriods`| array of tracking periods objects | see [Tracking periods](#tracking-periods) section |
| `trackingPeriods`| Array of tracking periods objects | see [Tracking periods](#tracking-periods) section |

| `governance` | governance object | see [Governance](#governance) section |

Example:
Expand Down Expand Up @@ -71,10 +70,10 @@ Example:

```yaml
trackingPeriods:
startDate: 2023-01-01
endDate: 2024-12-31
schedule: "0 0 * * *"
serverLocation: London, GB
- startDate: 2023-01-01
endDate: 2024-12-31
schedule: "0 0 * * *"
serverLocation: London, GB
```

### Governance
Expand Down Expand Up @@ -127,10 +126,10 @@ donation: https://opencollective.com/opentermsarchive
languages: [en]
jurisdictions: [EU]
trackingPeriods:
startDate: 2023-01-01
endDate: 2024-12-31
schedule: "0 0 * * *"
serverLocation: London, GB
- startDate: 2023-01-01
endDate: 2024-12-31
schedule: "0 0 * * *"
serverLocation: London, GB
governance:
hosts:
- name: Ministry for Europe and Foreign Affairs
Expand Down
Loading