From 161c437db11c7f3eba2fe4d2b946dc825a9de99f Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Tue, 3 Dec 2024 16:33:32 +0100 Subject: [PATCH 01/10] Update metadata doc --- content/collections/create.en.md | 6 +- content/collections/metadata.en.md | 181 +++++++++++++++++++---------- 2 files changed, 126 insertions(+), 61 deletions(-) diff --git a/content/collections/create.en.md b/content/collections/create.en.md index 3136dc78..aee02682 100644 --- a/content/collections/create.en.md +++ b/content/collections/create.en.md @@ -9,7 +9,7 @@ You are considering creating a new collection to track terms with Open Terms A ## Define metadata -First of all, define the [metadata]({{< relref "collections/metadata" >}}) of the collection you would like to create. +First of all, define the [metadata]({{< relref "collections/metadata" >}}) of the collection you would like to create and keep them ready to be used when setting up the repositories. ## Check existing collections @@ -80,6 +80,10 @@ Issues labels will be added by the engine as problems are encountered when track - Update the README file with proper metadata: topic, maintainers, jurisdictions, languages… +#### Update metadata + +- Update the metadata file `metadata.yml` with the collection metadata you defined earlier. + ### Snapshots Create the snapshots repository by using the [`demo-snapshots` repository](https://github.com/OpenTermsArchive/demo-snapshots) as template: diff --git a/content/collections/metadata.en.md b/content/collections/metadata.en.md index 3781dbeb..c9761011 100644 --- a/content/collections/metadata.en.md +++ b/content/collections/metadata.en.md @@ -5,63 +5,124 @@ weight: 1 # Collection metadata -A collection is defined by the following metadata. - -## Description - -A concise description of the collection topic. - -### Examples - -- Largest global social media -- Most used social media in France -- Dating apps -- Platforms providing services to businesses - -## Name - -Three words maximum. - -### Examples - -- Platform Governance Archive -- France Élections -- Dating -- P2B Compliance Assessment - -## ID - -An identifier derived from the collection name that can more easily be referenced in code. Use acronyms and replace spaces with dashes. - -### Examples - -- `pga` -- `France-elections` -- `dating` -- `p2b-compliance` - -## Language - -The expected language of the terms in the collection. - -### Examples - -- `English` -- `French` -- `All EU languages` - -## Jurisdiction - -The expected jurisdiction in which the terms in the collection apply. - -### Examples - -- `EU` -- `France` -- `EEA` -- `USA` -- `global` - -## Roles - -The name, URL and logo of the entities that will take responsibility for each of the necessary governance [roles]({{< relref "collections/governance" >}}). +A collection is defined by the following metadata fields: + +| JSON Field | Type | Required | Description | Example | +|------------|------|----------|-------------|---------| +| `name` | string | ✓ | Display name of the collection (max 3 words) | Platform Governance Archive | +| `id` | string | ✓ | Unique identifier derived from name (acronyms, dash-separated) | `pga` | +| `tagline` | string | ✓ | Concise description of collection topic | Largest global social media | +| `description` | string | - | Detailed context beyond tagline | Comprehensive collection of terms of service from major global social media platforms. | +| `languages` | Array of strings | ✓ | ISO 639 language codes allowed in collection | `["en", "fr", "de"]` | +| `jurisdictions` | Array of strings | ✓ | ISO 3166-2 country codes for covered jurisdictions | `["EU", "global"]` | +| `trackingPeriods` | object | - | Information about tracking schedule | see [Tracking Periods](#tracking-periods) section | +| `dataset` | url | - | URL to released versions dataset | `https://github.com/OpenTermsArchive/demo-versions/releases` | +| `declarations` | url | - | URL to declarations repository | `https://github.com/OpenTermsArchive/demo-declarations` | +| `versions` | url | - | URL to versions repository | `https://github.com/OpenTermsArchive/demo-versions` | +| `snapshots` | url | - | URL to snapshots repository | `https://github.com/OpenTermsArchive/demo-snapshots` | +| `logo` | url | - | URL to collection logo | `https://opentermsarchive.org/images/collections/demo.png` | +| `governance` | object | - | Governance information | see [Governance](#governance) section | +| `donation` | url | - | URL to donation page | `https://opentermsarchive.org/donate` | + +## Tracking periods + +Information about when and how terms are tracked: + +| JSON Field | Type | Required | Description | Example | +|------------|------|----------|-------------|---------| +| `startDate` | date | - | Date when tracking began | `2023-01-01` | +| `endDate` | date | - | Date when tracking ended/will end. No end date means tracking is ongoing. | `2024-12-31` | +| `schedule` | string | - | Cron expression defining tracking frequency | `0 0 * * *` (daily at midnight) | +| `serverLocation` | string | - | Geographic location of tracking server | `London, GB` | + +**Example:** + +```yaml +trackingPeriods: + startDate: 2023-01-01 + endDate: 2024-12-31 + schedule: "0 0 * * *" + serverLocation: London, GB +``` + +## Governance + +Organizations responsible for collection roles: + +| JSON Field | Type | Required | Description | Example | +|------------|------|----------|-------------|---------| +| `hosts` | Array of objects | - | Organizations hosting the collection | see [Organization](#organization) section | +| `administrators` | Array of objects | - | Organizations managing the collection | see [Organization](#organization) section | +| `curators` | Array of objects | - | Organizations curating the content | see [Organization](#organization) section | +| `maintainers` | Array of objects | - | Organizations maintaining the technical aspects | see [Organization](#organization) section | +| `sponsors` | Array of objects | - | Organizations providing support | see [Organization](#organization) section | + +## Organization + +Each organization in the governance roles is defined by the following fields: + +| JSON Field | Type | Required | Description | Example | +|------------|------|----------|-------------|---------| +| `name` | string | - | Name of the organization | `Open Terms Archive` | +| `url` | url | - | Website URL of the organization | `https://opentermsarchive.org/` | +| `logo` | url | - | URL to the organization's logo | `https://opentermsarchive.org/images/logo/logo.png` | + +**Example:** + +```yaml +governance: + administrators: + - name: Open Terms Archive + url: https://opentermsarchive.org/ + logo: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png + curators: [] + maintainers: [] + hosts: [] + sponsors: [] +``` + +**Complete metadata example:** + +```yaml +id: demo +name: Demo +tagline: Services needed to operate the Open Terms Archive engine +description: This demo collection serves as a reference implementation... +dataset: https://github.com/OpenTermsArchive/demo-versions/releases +declarations: https://github.com/OpenTermsArchive/demo-declarations +versions: https://github.com/OpenTermsArchive/demo-versions +snapshots: https://github.com/OpenTermsArchive/demo-snapshots +logo: https://opentermsarchive.org/images/collections/demo.png +languages: + - en +jurisdictions: + - EU +termsTracked: 100 +servicesTracked: 50 +trackingPeriods: + startDate: 2023-01-01 + endDate: 2024-12-31 + schedule: "0 0 * * *" + serverLocation: EU-WEST-1 +governance: + hosts: + - name: Ministry for Europe and Foreign Affairs + url: https://www.diplomatie.gouv.fr/en/ + logo: https://opentermsarchive.org/images/contributors/meae.png + administrators: + - name: Open Terms Archive + url: https://opentermsarchive.org/ + logo: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png + curators: + - name: Open Terms Archive + url: https://opentermsarchive.org/ + logo: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png + maintainers: + - name: Open Terms Archive + url: https://opentermsarchive.org/ + logo: https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png + sponsors: + - name: Ministry for Europe and Foreign Affairs + url: https://www.diplomatie.gouv.fr/en/ + logo: https://opentermsarchive.org/images/contributors/meae.png +``` From 999bcee31dd041d92a3a1931cbeb8abf03aa9926 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 10:17:11 +0100 Subject: [PATCH 02/10] Improve table display --- .../assets/css/elements/table.css | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/themes/opentermsarchive/assets/css/elements/table.css b/themes/opentermsarchive/assets/css/elements/table.css index 4dff7c89..efabbbf0 100644 --- a/themes/opentermsarchive/assets/css/elements/table.css +++ b/themes/opentermsarchive/assets/css/elements/table.css @@ -1,30 +1,28 @@ table { border-collapse: collapse; width: 100%; + margin-bottom: var(--mM); & thead { & tr { + & th { - padding: var(--pXS) var(--pM); - border-bottom: 1px solid var(--colorBlack300); - border-right: 1px solid var(--colorBlack300); + border: 1px solid var(--colorBlack300); + padding: var(--pXS) var(--pS); background-color: var(--colorBlack200); - - &:last-child { - border-right: 1px solid var(--colorBlack200); - } - &:first-child { - border-left: 1px solid var(--colorBlack200); - } } } } & tbody { & tr { & td { - padding: var(--pXS) var(--pM); - border: 1px solid var(--colorBlack200); + padding: var(--pXS) var(--pS); + border: 1px solid var(--colorBlack300); } } + + & tr:nth-child(2n) { + background-color: rgb(246, 248, 250); + } } } From 8f5cd0bd992b82feddb9c099f26b4550a9e1a548 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 10:17:56 +0100 Subject: [PATCH 03/10] Improve code display --- .../css/components/textContent/textContent.css | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/themes/opentermsarchive/assets/css/components/textContent/textContent.css b/themes/opentermsarchive/assets/css/components/textContent/textContent.css index aa804045..c7d428f9 100644 --- a/themes/opentermsarchive/assets/css/components/textContent/textContent.css +++ b/themes/opentermsarchive/assets/css/components/textContent/textContent.css @@ -108,7 +108,8 @@ & blockquote + h2, & .highlight + h2, & details + h2, - & video + h2{ + & video + h2 + & table + h2 { margin-top: var(--m2XL); } @@ -118,7 +119,8 @@ & blockquote + h3, & .highlight + h3, & details + h3, - & video + h3 { + & video + h3, + & table + h2 { margin-top: var(--mXL); } @@ -195,14 +197,19 @@ margin-bottom: var(--mM); } - & pre{ - padding:0.8rem; + & pre { + padding: 1.5rem; overflow-x: scroll; } + & :not(pre) > code { + padding: 0.2em 0.4em; + border-radius: 0.3em; + } + & code { background-color: var(--colorBlack200); - font-size: 0.95em; + font-size: 0.9em; } & button { From 631e42a5f296e519837fe03e5a1f3dc5cb46cc9c Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 10:18:06 +0100 Subject: [PATCH 04/10] Improve metadata page --- content/collections/metadata.en.md | 108 +++++++++++++++++------------ 1 file changed, 65 insertions(+), 43 deletions(-) diff --git a/content/collections/metadata.en.md b/content/collections/metadata.en.md index c9761011..a2937b9c 100644 --- a/content/collections/metadata.en.md +++ b/content/collections/metadata.en.md @@ -5,37 +5,60 @@ weight: 1 # Collection metadata -A collection is defined by the following metadata fields: - -| JSON Field | Type | Required | Description | Example | -|------------|------|----------|-------------|---------| -| `name` | string | ✓ | Display name of the collection (max 3 words) | Platform Governance Archive | -| `id` | string | ✓ | Unique identifier derived from name (acronyms, dash-separated) | `pga` | -| `tagline` | string | ✓ | Concise description of collection topic | Largest global social media | -| `description` | string | - | Detailed context beyond tagline | Comprehensive collection of terms of service from major global social media platforms. | -| `languages` | Array of strings | ✓ | ISO 639 language codes allowed in collection | `["en", "fr", "de"]` | -| `jurisdictions` | Array of strings | ✓ | ISO 3166-2 country codes for covered jurisdictions | `["EU", "global"]` | -| `trackingPeriods` | object | - | Information about tracking schedule | see [Tracking Periods](#tracking-periods) section | -| `dataset` | url | - | URL to released versions dataset | `https://github.com/OpenTermsArchive/demo-versions/releases` | -| `declarations` | url | - | URL to declarations repository | `https://github.com/OpenTermsArchive/demo-declarations` | -| `versions` | url | - | URL to versions repository | `https://github.com/OpenTermsArchive/demo-versions` | -| `snapshots` | url | - | URL to snapshots repository | `https://github.com/OpenTermsArchive/demo-snapshots` | -| `logo` | url | - | URL to collection logo | `https://opentermsarchive.org/images/collections/demo.png` | -| `governance` | object | - | Governance information | see [Governance](#governance) section | -| `donation` | url | - | URL to donation page | `https://opentermsarchive.org/donate` | +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. + +Below is the list of all metadata fields: + +| Field | Type | Description | +|----------------|-----------------|---------------------------------------| +| `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 allowed in collection | +| `jurisdictions`| Array of strings| ISO 3166-2 country codes for covered jurisdictions | +| `trackingPeriods`| object | Information about tracking schedule | +| `dataset` | url | URL to released versions dataset | +| `declarations` | url | URL to declarations repository | +| `versions` | url | URL to versions repository | +| `snapshots` | url | URL to snapshots repository | +| `logo` | url | URL to collection logo | +| `governance` | object | Governance information | +| `donation` | url | URL to donation page | + +Example: + +```yaml +name: Platform Governance Archive +id: pga +tagline: Largest global social media +description: Comprehensive collection of terms of service from major global social media platforms. +languages: + - en + - fr + - de +jurisdictions: + - EU +dataset: https://github.com/OpenTermsArchive/demo-versions/releases +declarations: https://github.com/OpenTermsArchive/demo-declarations +versions: https://github.com/OpenTermsArchive/demo-versions +snapshots: https://github.com/OpenTermsArchive/demo-snapshots +logo: https://opentermsarchive.org/images/collections/demo.png +donation: https://opentermsarchive.org/donate +``` ## Tracking periods Information about when and how terms are tracked: -| JSON Field | Type | Required | Description | Example | -|------------|------|----------|-------------|---------| -| `startDate` | date | - | Date when tracking began | `2023-01-01` | -| `endDate` | date | - | Date when tracking ended/will end. No end date means tracking is ongoing. | `2024-12-31` | -| `schedule` | string | - | Cron expression defining tracking frequency | `0 0 * * *` (daily at midnight) | -| `serverLocation` | string | - | Geographic location of tracking server | `London, GB` | +| Field | Type | Description | +|---------------|--------|--------------------------------------------| +| `startDate` | date | Date when tracking began | +| `endDate` | date | Date when tracking ended/will end. No end date means tracking is ongoing. | +| `schedule` | string | Cron expression defining tracking frequency | +| `serverLocation`| string| Geographic location of tracking server | -**Example:** +Example: ```yaml trackingPeriods: @@ -49,25 +72,25 @@ trackingPeriods: Organizations responsible for collection roles: -| JSON Field | Type | Required | Description | Example | -|------------|------|----------|-------------|---------| -| `hosts` | Array of objects | - | Organizations hosting the collection | see [Organization](#organization) section | -| `administrators` | Array of objects | - | Organizations managing the collection | see [Organization](#organization) section | -| `curators` | Array of objects | - | Organizations curating the content | see [Organization](#organization) section | -| `maintainers` | Array of objects | - | Organizations maintaining the technical aspects | see [Organization](#organization) section | -| `sponsors` | Array of objects | - | Organizations providing support | see [Organization](#organization) section | +| Field | Type | Description | +|---------------|-----------------|----------------------------------------| +| `hosts` | Array of objects| Organizations hosting the collection | +| `administrators`| Array of objects| Organizations managing the collection | +| `curators` | Array of objects| Organizations curating the content | +| `maintainers` | Array of objects| Organizations maintaining the technical aspects | +| `sponsors` | Array of objects| Organizations providing support | ## Organization Each organization in the governance roles is defined by the following fields: -| JSON Field | Type | Required | Description | Example | -|------------|------|----------|-------------|---------| -| `name` | string | - | Name of the organization | `Open Terms Archive` | -| `url` | url | - | Website URL of the organization | `https://opentermsarchive.org/` | -| `logo` | url | - | URL to the organization's logo | `https://opentermsarchive.org/images/logo/logo.png` | +| Field | Type | Description | +|---------------|--------|-------------------------------------------| +| `name` | string | Name of the organization | +| `url` | url | Website URL of the organization | +| `logo` | url | URL to the organization's logo | -**Example:** +Example: ```yaml governance: @@ -81,29 +104,28 @@ governance: sponsors: [] ``` -**Complete metadata example:** +## Complete metadata example ```yaml id: demo name: Demo tagline: Services needed to operate the Open Terms Archive engine -description: This demo collection serves as a reference implementation... +description: This demo collection serves as a reference implementation… dataset: https://github.com/OpenTermsArchive/demo-versions/releases declarations: https://github.com/OpenTermsArchive/demo-declarations versions: https://github.com/OpenTermsArchive/demo-versions snapshots: https://github.com/OpenTermsArchive/demo-snapshots logo: https://opentermsarchive.org/images/collections/demo.png +donation: https://opentermsarchive.org/donate languages: - en jurisdictions: - EU -termsTracked: 100 -servicesTracked: 50 trackingPeriods: startDate: 2023-01-01 endDate: 2024-12-31 schedule: "0 0 * * *" - serverLocation: EU-WEST-1 + serverLocation: London, GB governance: hosts: - name: Ministry for Europe and Foreign Affairs From 3942e6637b4a4f75490a3e60e4645f671258c2b0 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 10:58:35 +0100 Subject: [PATCH 05/10] Improve table style --- themes/opentermsarchive/assets/css/elements/table.css | 1 + 1 file changed, 1 insertion(+) diff --git a/themes/opentermsarchive/assets/css/elements/table.css b/themes/opentermsarchive/assets/css/elements/table.css index efabbbf0..b02d66f2 100644 --- a/themes/opentermsarchive/assets/css/elements/table.css +++ b/themes/opentermsarchive/assets/css/elements/table.css @@ -7,6 +7,7 @@ table { & tr { & th { + text-align: left; border: 1px solid var(--colorBlack300); padding: var(--pXS) var(--pS); background-color: var(--colorBlack200); From 608289d4cefebf3dc016b2e060e73e4d53869893 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 10:58:46 +0100 Subject: [PATCH 06/10] Improve metadata page --- content/collections/metadata.en.md | 69 ++++++++++++++++-------------- 1 file changed, 37 insertions(+), 32 deletions(-) diff --git a/content/collections/metadata.en.md b/content/collections/metadata.en.md index a2937b9c..bfa3c569 100644 --- a/content/collections/metadata.en.md +++ b/content/collections/metadata.en.md @@ -5,9 +5,9 @@ weight: 1 # Collection metadata -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. +A collection is defined by the following metadata. -Below is the list of all metadata fields: +## Required fields | Field | Type | Description | |----------------|-----------------|---------------------------------------| @@ -17,34 +17,43 @@ Below is the list of all metadata fields: | `description` | string | Detailed context beyond tagline | | `languages` | Array of strings| ISO 639 language codes allowed in collection | | `jurisdictions`| Array of strings| ISO 3166-2 country codes for covered jurisdictions | -| `trackingPeriods`| object | Information about tracking schedule | + +Example: + +```yaml +name: Platform Governance Archive +id: pga +tagline: Largest global social media +languages: [en, fr, de] +jurisdictions: [EU] +``` + +## Additional fields + +Additional fields are optional but highly recommended to facilitate better discovery, comprehension, and utilization of the collection. + +| Field | Type | Description | +|----------------|-----------------|---------------------------------------| +| `description` | string | Detailed context beyond tagline | | `dataset` | url | URL to released versions dataset | | `declarations` | url | URL to declarations repository | | `versions` | url | URL to versions repository | | `snapshots` | url | URL to snapshots repository | -| `logo` | url | URL to collection logo | -| `governance` | object | Governance information | +| `logo` | url | URL to the collection's logo. Optimized PNG transparent image (min size 240px) | | `donation` | url | URL to donation page | +| `trackingPeriods`| tracking periods object | see [Tracking periods](#tracking-periods) section | +| `governance` | governance object | see [Governance](#governance) section | Example: ```yaml -name: Platform Governance Archive -id: pga -tagline: Largest global social media description: Comprehensive collection of terms of service from major global social media platforms. -languages: - - en - - fr - - de -jurisdictions: - - EU dataset: https://github.com/OpenTermsArchive/demo-versions/releases declarations: https://github.com/OpenTermsArchive/demo-declarations versions: https://github.com/OpenTermsArchive/demo-versions snapshots: https://github.com/OpenTermsArchive/demo-snapshots logo: https://opentermsarchive.org/images/collections/demo.png -donation: https://opentermsarchive.org/donate +donation: https://opencollective.com/opentermsarchive ``` ## Tracking periods @@ -53,10 +62,10 @@ Information about when and how terms are tracked: | Field | Type | Description | |---------------|--------|--------------------------------------------| -| `startDate` | date | Date when tracking began | -| `endDate` | date | Date when tracking ended/will end. No end date means tracking is ongoing. | -| `schedule` | string | Cron expression defining tracking frequency | -| `serverLocation`| string| Geographic location of tracking server | +| `startDate` | date (ISO 8601 format: YYYY-MM-DD) | The date when tracking started | +| `endDate` | date (ISO 8601 format: YYYY-MM-DD) | The date when tracking ended or will end. If not specified, tracking is ongoing. | +| `schedule` | string | A [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) that defines the tracking frequency | +| `serverLocation`| string (city name, ISO 3166-2 country code) | The geographic location of the tracking server | Example: @@ -74,21 +83,19 @@ Organizations responsible for collection roles: | Field | Type | Description | |---------------|-----------------|----------------------------------------| -| `hosts` | Array of objects| Organizations hosting the collection | -| `administrators`| Array of objects| Organizations managing the collection | -| `curators` | Array of objects| Organizations curating the content | -| `maintainers` | Array of objects| Organizations maintaining the technical aspects | -| `sponsors` | Array of objects| Organizations providing support | - -## Organization +| `hosts` | Array of organizations objects| Organizations hosting the collection | +| `administrators`| Array of organizations objects| Organizations managing the collection | +| `curators` | Array of organizations objects| Organizations curating the content | +| `maintainers` | Array of organizations objects| Organizations maintaining the technical aspects | +| `sponsors` | Array of organizations objects| Organizations providing support | Each organization in the governance roles is defined by the following fields: | Field | Type | Description | |---------------|--------|-------------------------------------------| | `name` | string | Name of the organization | -| `url` | url | Website URL of the organization | -| `logo` | url | URL to the organization's logo | +| `url` | url | Website URL of the organization (optional) | +| `logo` | url | URL to the organization's logo. Optimized PNG transparent image (min size 240px) (optional) | Example: @@ -117,10 +124,8 @@ versions: https://github.com/OpenTermsArchive/demo-versions snapshots: https://github.com/OpenTermsArchive/demo-snapshots logo: https://opentermsarchive.org/images/collections/demo.png donation: https://opentermsarchive.org/donate -languages: - - en -jurisdictions: - - EU +languages: [en] +jurisdictions: [EU] trackingPeriods: startDate: 2023-01-01 endDate: 2024-12-31 From ce211c6ae135124277730278e6bc08381d9f6c81 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 11:02:12 +0100 Subject: [PATCH 07/10] Improve metadata page --- content/collections/metadata.en.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/collections/metadata.en.md b/content/collections/metadata.en.md index bfa3c569..e405a7ee 100644 --- a/content/collections/metadata.en.md +++ b/content/collections/metadata.en.md @@ -39,7 +39,7 @@ Additional fields are optional but highly recommended to facilitate better disco | `declarations` | url | URL to declarations repository | | `versions` | url | URL to versions repository | | `snapshots` | url | URL to snapshots repository | -| `logo` | url | URL to the collection's logo. Optimized PNG transparent image (min size 240px) | +| `logo` | url | URL to the collection's logo. Optimized PNG transparent image (min wi 240px) | | `donation` | url | URL to donation page | | `trackingPeriods`| tracking periods object | see [Tracking periods](#tracking-periods) section | | `governance` | governance object | see [Governance](#governance) section | @@ -56,7 +56,7 @@ logo: https://opentermsarchive.org/images/collections/demo.png donation: https://opencollective.com/opentermsarchive ``` -## Tracking periods +### Tracking periods Information about when and how terms are tracked: @@ -77,7 +77,7 @@ trackingPeriods: serverLocation: London, GB ``` -## Governance +### Governance Organizations responsible for collection roles: @@ -95,7 +95,7 @@ Each organization in the governance roles is defined by the following fields: |---------------|--------|-------------------------------------------| | `name` | string | Name of the organization | | `url` | url | Website URL of the organization (optional) | -| `logo` | url | URL to the organization's logo. Optimized PNG transparent image (min size 240px) (optional) | +| `logo` | url | URL to the organization's logo. Optimized PNG transparent image (min width 240px) (optional) | Example: From 357e7d2e370bf371d3c36305c7bb38823632efd8 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 11:04:17 +0100 Subject: [PATCH 08/10] Fix example --- content/collections/metadata.en.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/collections/metadata.en.md b/content/collections/metadata.en.md index e405a7ee..b4af1251 100644 --- a/content/collections/metadata.en.md +++ b/content/collections/metadata.en.md @@ -123,7 +123,7 @@ declarations: https://github.com/OpenTermsArchive/demo-declarations versions: https://github.com/OpenTermsArchive/demo-versions snapshots: https://github.com/OpenTermsArchive/demo-snapshots logo: https://opentermsarchive.org/images/collections/demo.png -donation: https://opentermsarchive.org/donate +donation: https://opencollective.com/opentermsarchive languages: [en] jurisdictions: [EU] trackingPeriods: From f4c8e5bf6b27580ff39f29f55912fe82d1735481 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 11:04:56 +0100 Subject: [PATCH 09/10] Add links --- content/collections/metadata.en.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/collections/metadata.en.md b/content/collections/metadata.en.md index b4af1251..5eabd100 100644 --- a/content/collections/metadata.en.md +++ b/content/collections/metadata.en.md @@ -62,10 +62,10 @@ Information about when and how terms are tracked: | Field | Type | Description | |---------------|--------|--------------------------------------------| -| `startDate` | date (ISO 8601 format: YYYY-MM-DD) | The date when tracking started | -| `endDate` | date (ISO 8601 format: YYYY-MM-DD) | The date when tracking ended or will end. If not specified, tracking is ongoing. | +| `startDate` | date ([ISO 8601 format: YYYY-MM-DD](https://en.wikipedia.org/wiki/ISO_8601)) | The date when tracking started | +| `endDate` | date ([ISO 8601 format: YYYY-MM-DD](https://en.wikipedia.org/wiki/ISO_8601)) | The date when tracking ended or will end. If not specified, tracking is ongoing. | | `schedule` | string | A [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) that defines the tracking frequency | -| `serverLocation`| string (city name, ISO 3166-2 country code) | The geographic location of the tracking server | +| `serverLocation`| string (city name, [ISO 3166-2 country code](https://en.wikipedia.org/wiki/ISO_3166-2)) | The geographic location of the tracking server | Example: From 8f6595a417507750c9055011e7b6f2cd32405f92 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Wed, 4 Dec 2024 11:06:15 +0100 Subject: [PATCH 10/10] Add links --- content/collections/metadata.en.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/collections/metadata.en.md b/content/collections/metadata.en.md index 5eabd100..f96435ed 100644 --- a/content/collections/metadata.en.md +++ b/content/collections/metadata.en.md @@ -15,8 +15,8 @@ A collection is defined by the following metadata. | `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 allowed in collection | -| `jurisdictions`| Array of strings| ISO 3166-2 country codes for covered jurisdictions | +| `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 | Example: @@ -39,7 +39,7 @@ Additional fields are optional but highly recommended to facilitate better disco | `declarations` | url | URL to declarations repository | | `versions` | url | URL to versions repository | | `snapshots` | url | URL to snapshots repository | -| `logo` | url | URL to the collection's logo. Optimized PNG transparent image (min wi 240px) | +| `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 | | `governance` | governance object | see [Governance](#governance) section |