diff --git a/content/collections/reference/metadata.md b/content/collections/reference/metadata.md index d4bbd1a7..2ee2083d 100644 --- a/content/collections/reference/metadata.md +++ b/content/collections/reference/metadata.md @@ -16,7 +16,7 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch {{< configOption name="id" type="string" - description="Unique identifier derived from name (acronyms, dash-separated)" + description="Unique identifier derived from name (acronyms, dash-separated)." example="`pga`" required=true >}} @@ -24,7 +24,7 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch {{< configOption name="name" type="string" - description="Display name of the collection (max 3 words)" + description="Display name of the collection (max 3 words)." example="`Platform Governance Archive`" required=true >}} @@ -32,7 +32,7 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch {{< configOption name="tagline" type="string" - description="Concise description of collection topic" + description="Concise description of collection topic." example="`Major global social media services`" required=true >}} @@ -40,7 +40,7 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch {{< configOption name="languages" type="Array of strings" - description="[ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection" + description="[ISO 639 language codes](https://en.wikipedia.org/wiki/ISO_639) allowed in collection." example="`[en, fr, de]`" required=true >}} @@ -48,7 +48,7 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch {{< configOption name="jurisdictions" type="Array of strings" - description="[ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions" + description="[ISO 3166-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-2) for covered jurisdictions." example="`[EU]`" required=true >}} @@ -56,7 +56,7 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch {{< configOption name="description" type="string" - description="Detailed description of the collection" + description="Detailed description of the collection." example=`The **Platform Governance Archive** (PGA) collection tracks the terms of major global social media services. This data is maintained and analysed by the [Platform Governance Archive](https://www.platformgovernancearchive.org/) at the Universität Bremen's [Center for Media Communication and Information Research (ZeMKI)](https://www.uni-bremen.de/zemki). @@ -69,55 +69,55 @@ It also aims to promote greater transparency and accountability of these powerfu {{< configOption name="dataset" type="url" - description="URL to released versions dataset" + description="URL to released versions dataset." example="`https://github.com/OpenTermsArchive/pga-versions/releases`" >}} {{< configOption name="declarations" type="url" - description="URL to declarations repository" + description="URL to declarations repository." example="`https://github.com/OpenTermsArchive/pga-declarations`" >}} {{< configOption name="versions" type="url" - description="URL to versions repository" + description="URL to versions repository." example="`https://github.com/OpenTermsArchive/pga-versions`" >}} {{< configOption name="snapshots" type="url" - description="URL to snapshots repository" + description="URL to snapshots repository." example="`https://github.com/OpenTermsArchive/pga-snapshots`" >}} {{< configOption name="logo" type="url" - description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)" + description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)." example="`https://opentermsarchive.org/images/collections/pga.png`" >}} {{< configOption name="donations" type="url" - description="URL to the donations page" + description="URL to the donations page." example="`https://opencollective.com/opentermsarchive`" >}} {{< configOption name="trackingPeriods" type="array of tracking periods objects" - description="Tracking periods object, see [Tracking periods](#tracking-periods) section" + description="Tracking periods object, see [Tracking periods](#tracking-periods) section." >}} {{< configOption name="governance" type="array of entity objects" - description="Entity object, see [Entity](#entity) section" + description="Entity object, see [Entity](#entity) section." >}} --- @@ -127,7 +127,7 @@ It also aims to promote greater transparency and accountability of these powerfu {{< configOption name="startDate" type="date" - description="The date when tracking started (ISO 8601 format: YYYY-MM-DD)" + description="The date when tracking started (ISO 8601 format: YYYY-MM-DD)." example="`2023-01-01`" required=true >}} @@ -142,7 +142,7 @@ It also aims to promote greater transparency and accountability of these powerfu {{< configOption name="schedule" type="string" - description="A [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) that defines the tracking frequency" + description="A [cron expression](https://en.wikipedia.org/wiki/Cron#Cron_expression) that defines the tracking frequency." example="`0 0 * * *`" required=true >}} @@ -150,7 +150,7 @@ It also aims to promote greater transparency and accountability of these powerfu {{< configOption name="serverLocation" type="string" - description="The geographic location of the tracking server (city name, ISO 3166-2 country code)" + description="The geographic location of the tracking server (city name, ISO 3166-2 country code)." example="`London, GB`" required=true >}} @@ -162,7 +162,7 @@ It also aims to promote greater transparency and accountability of these powerfu {{< configOption name="name" type="string" - description="Name of the organization" + description="Name of the organization." example="`Open Terms Archive`" required=true >}} @@ -170,21 +170,21 @@ It also aims to promote greater transparency and accountability of these powerfu {{< configOption name="url" type="url" - description="Website URL of the organization" + description="Website URL of the organization." example="`https://opentermsarchive.org/`" >}} {{< configOption name="logo" type="url" - description="URL to the organization's logo. Optimized PNG transparent image (min width 240px)" + description="URL to the organization's logo. Optimized PNG transparent image (min width 240px)." example="`https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png`" >}} {{< configOption name="roles" type="string" - description="Roles of the entity within the governance" + description="Roles of the entity within the governance, see [collection governance]({{< relref \"collections/reference/governance\" >}})." allowedValues="`host`, `administrator`, `curator`, `maintainer`, `sponsor`" required=true >}}