Skip to content

Commit a3b4401

Browse files
committed
Update metadata specs
1 parent 0d84b56 commit a3b4401

File tree

1 file changed

+25
-20
lines changed

1 file changed

+25
-20
lines changed

content/collections/reference/metadata.md

+25-20
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch
1717
name="id"
1818
type="string"
1919
description="Unique identifier derived from name (acronyms, dash-separated)."
20-
example="pga"
20+
example="demo"
2121
required=true
2222
>}}
2323
2424
{{< configOption
2525
name="name"
2626
type="string"
2727
description="Display name of the collection."
28-
example="Platform Governance Archive"
28+
example="Demo Collection"
2929
required=true
3030
>}}
3131
3232
{{< configOption
3333
name="tagline"
3434
type="string"
3535
description="Concise description of collection topic."
36-
example="Major global social media services"
36+
example="Services used by Open Terms Archive"
3737
required=true
3838
>}}
3939
@@ -57,46 +57,42 @@ As an example, see the [complete metadata file](https://github.com/OpenTermsArch
5757
name="description"
5858
type="string"
5959
description="Detailed description of the collection"
60-
example=`The **Platform Governance Archive** (PGA) collection tracks the terms of major global social media services.
61-
62-
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).
63-
64-
This initiative offers researchers, journalists and citizens the tools to analyze how platforms structure and regulate communication and interaction in our societies.
65-
66-
It also aims to promote greater transparency and accountability of these powerful digital services.
67-
`
60+
example=` The **Demo** collection tracks changes to the terms of use of services used by Open Terms Archive.
61+
62+
This provides a reference collection for best practices and enables the Open Terms Archive Core Team to be a user of the software it produces.
63+
`
6864
required=false
6965
>}}
7066
7167
{{< configOption
7268
name="dataset"
7369
type="uri"
7470
description="URL to the dataset releases."
75-
example="https://github.com/OpenTermsArchive/pga-versions/releases"
71+
example="https://github.com/OpenTermsArchive/demo-versions/releases"
7672
required=false
7773
>}}
7874
7975
{{< configOption
8076
name="declarations"
8177
type="uri"
8278
description="URL to the declarations repository."
83-
example="https://github.com/OpenTermsArchive/pga-declarations"
79+
example="https://github.com/OpenTermsArchive/demo-declarations"
8480
required=false
8581
>}}
8682
8783
{{< configOption
8884
name="versions"
8985
type="uri"
9086
description="URL to the versions repository."
91-
example="https://github.com/OpenTermsArchive/pga-versions"
87+
example="https://github.com/OpenTermsArchive/demo-versions"
9288
required=false
9389
>}}
9490
9591
{{< configOption
9692
name="snapshots"
9793
type="uri"
9894
description="URL to the snapshots repository."
99-
example="https://github.com/OpenTermsArchive/pga-snapshots"
95+
example="https://github.com/OpenTermsArchive/demo-snapshots"
10096
required=false
10197
>}}
10298
@@ -111,7 +107,8 @@ It also aims to promote greater transparency and accountability of these powerfu
111107
{{< configOption
112108
name="logo"
113109
type="uri"
114-
description="URL to the collection's logo. Optimized PNG transparent image (min width 240px)."
110+
description="URL to the collection's logo. Optimized PNG transparent image (minimum width 240px)."
111+
example="https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png"
115112
required=false
116113
>}}
117114
@@ -133,6 +130,14 @@ It also aims to promote greater transparency and accountability of these powerfu
133130
name="i18n"
134131
type="object"
135132
description="Internationalization of any of the Metadata properties (except i18n itself) for different language codes"
133+
example=` fr:
134+
name: Démo
135+
tagline: Services utilisés par Open Terms Archive
136+
governance:
137+
Ministry for Europe and Foreign Affairs:
138+
name: Ministère de l'Europe et des Affaires étrangères
139+
url: https://www.diplomatie.gouv.fr
140+
`
136141
required=false
137142
>}}
138143
@@ -159,8 +164,8 @@ It also aims to promote greater transparency and accountability of these powerfu
159164
{{< configOption
160165
name="serverLocation"
161166
type="string"
162-
description="The geographic location of the tracking server (city name, ISO 3166-2 country code)."
163-
example="London, GB"
167+
description="The geographic location of the tracking server (city name and ISO 3166-2 country code)."
168+
example="Paris, FR"
164169
required=true
165170
>}}
166171
@@ -188,7 +193,7 @@ It also aims to promote greater transparency and accountability of these powerfu
188193
{{< configOption
189194
name="logo"
190195
type="uri"
191-
description="URL to the entity's logo. Optimized PNG transparent image (min width 240px)."
196+
description="URL to the entity's logo. Optimized PNG transparent image (minimum width 240px)."
192197
example="https://opentermsarchive.org/images/logo/logo-open-terms-archive-black.png"
193198
required=false
194199
>}}
@@ -199,5 +204,5 @@ It also aims to promote greater transparency and accountability of these powerfu
199204
description="Roles of the entity within the governance, see [collection governance](https://docs.opentermsarchive.org/collections/reference/governance/)"
200205
allowedValues="`host`, `administrator`, `curator`, `maintainer`, `sponsor`"
201206
example="[host, administrator]"
202-
required=false
207+
required=true
203208
>}}

0 commit comments

Comments
 (0)