Skip to content

Update dataset configuration reference #207

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
Ndpnt merged 2 commits into from
Jan 6, 2026
Merged

Update dataset configuration reference #207

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
feb6b1d
Update doc
Ndpnt Jan 6, 2026
a394488
Update default values
Ndpnt Jan 6, 2026
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
11 changes: 8 additions & 3 deletions content/collections/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,14 +186,16 @@ The dataset section configures how datasets are published. Datasets can be publi
name="dataset.title"
type="string"
description="Title of the dataset."
default="sandbox"
example="Contrib collection dataset"
required=true
/>}}

{{< refItem
name="dataset.versionsRepositoryURL"
type="string"
description="Repository URL for dataset releases."
default="https://github.com/OpenTermsArchive/sandbox"
description="Repository URL for dataset releases. Also used to generate the dataset README."
example="https://github.com/OpenTermsArchive/contrib-versions"
required=true
/>}}

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

{{< refItem
name="dataset.datagouv.organizationIdOrSlug"
type="string"
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."
example="open-terms-archive"
required=true
/>}}

{{< refItem
name="dataset.datagouv.frequency"
type="string"
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."
example="weekly"
required=true
/>}}

{{< refItem
Expand Down