Skip to content

Commit 2015a6b

Browse files
authored
Update dataset configuration reference (#207)
2 parents a5f9673 + a394488 commit 2015a6b

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

content/collections/reference/configuration.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,14 +186,16 @@ The dataset section configures how datasets are published. Datasets can be publi
186186
name="dataset.title"
187187
type="string"
188188
description="Title of the dataset."
189-
default="sandbox"
189+
example="Contrib collection dataset"
190+
required=true
190191
/>}}
191192

192193
{{< refItem
193194
name="dataset.versionsRepositoryURL"
194195
type="string"
195-
description="Repository URL for dataset releases."
196-
default="https://github.com/OpenTermsArchive/sandbox"
196+
description="Repository URL for dataset releases. Also used to generate the dataset README."
197+
example="https://github.com/OpenTermsArchive/contrib-versions"
198+
required=true
197199
/>}}
198200

199201
{{< refItem
@@ -212,20 +214,23 @@ The data.gouv.fr section configures publishing to the French government's open d
212214
type="string"
213215
description="ID of an existing dataset on data.gouv.fr. Use this to publish to an existing dataset. Either this or `organizationIdOrSlug` is required."
214216
example="6914a64b17a0a91bb0a61222"
217+
required=true
215218
/>}}
216219

217220
{{< refItem
218221
name="dataset.datagouv.organizationIdOrSlug"
219222
type="string"
220223
description="ID or slug of the organization on data.gouv.fr. Use this to automatically create and publish a dataset. The dataset will be created with the title from `dataset.title` if it doesn't exist. Either this or `datasetId` is required."
221224
example="open-terms-archive"
225+
required=true
222226
/>}}
223227

224228
{{< refItem
225229
name="dataset.datagouv.frequency"
226230
type="string"
227231
description="Update frequency of the dataset. Used when creating or updating a dataset on data.gouv.fr. See [data.gouv.fr API](https://www.data.gouv.fr/api/1/datasets/frequencies/) for all allowed values."
228232
example="weekly"
233+
required=true
229234
/>}}
230235

231236
{{< refItem

0 commit comments

Comments
 (0)