diff --git a/content/docs/recipes/enum-labels-and-ordering.md b/content/docs/recipes/enum-labels-and-ordering.md index b7ca8358..d0de5c3f 100644 --- a/content/docs/recipes/enum-labels-and-ordering.md +++ b/content/docs/recipes/enum-labels-and-ordering.md @@ -1,5 +1,7 @@ --- title: Enum Labels and Ordering +sidebar: + hidden: true --- diff --git a/content/docs/recipes/metadata-in-table-schema.md b/content/docs/recipes/metadata-in-table-schema.md index 25df3026..17e6b1fb 100644 --- a/content/docs/recipes/metadata-in-table-schema.md +++ b/content/docs/recipes/metadata-in-table-schema.md @@ -1,5 +1,7 @@ --- title: Metadata in Table Schema +sidebar: + hidden: true ---
diff --git a/content/docs/specifications/data-package.md b/content/docs/specifications/data-package.md index 6118f45d..d95e8b00 100644 --- a/content/docs/specifications/data-package.md +++ b/content/docs/specifications/data-package.md @@ -77,7 +77,7 @@ Several example data packages can be found in the [datasets organization on gith Data Package descriptor `MUST` be a descriptor as per [Descriptor](../glossary/#descriptor) definition. A list of standard properties that can be included into a descriptor is defined in the [Properties](#properties) section. -When available as a file a descriptor `MUST` be named `datapackage.json` and it `MUST` be placed in the top-level directory (relative to any other resources provided as part of the data package). +When a data package is available as a physical or virtual directory containing files, a descriptor `MUST` be named `datapackage.json` and it `MUST` be placed on the top-level of the file structure (relative to any other resources provided as part of the data package). The descriptor is the central file in a Data Package. It provides: @@ -116,7 +116,7 @@ Packaged data resources are described in the `resources` property of the package ### `$schema` -A root level Data Package descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Data Package descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/datapackage.json` and the recommended value is `https://datapackage.org/profiles/2.0/datapackage.json`. @@ -266,3 +266,15 @@ An example of the object structure is as follows: "path": "http://data.worldbank.org/indicator/NY.GDP.MKTP.CD" }] ``` + +## Related Work + +Data Package draws content and/or inspiration from, among others, the following specifications and implementations: + +- [DataCite](https://schema.datacite.org/) +- [Zenodo](https://zenodo.org/) +- [DCAT](https://www.w3.org/TR/vocab-dcat-3/) +- [CKAN](https://ckan.org/) +- [OAI-ORE](https://www.openarchives.org/ore/) +- [DataONE](https://dataone-architecture-documentation.readthedocs.io/en/latest/design/DataPackage.html) +- [Research Object Bundle](https://www.researchobject.org/specifications/bundle/) diff --git a/content/docs/specifications/data-resource.md b/content/docs/specifications/data-resource.md index d5bf3d4b..87086287 100644 --- a/content/docs/specifications/data-resource.md +++ b/content/docs/specifications/data-resource.md @@ -146,7 +146,7 @@ If a resource has `profile` property that equals to `tabular-data-resource` or ` #### `$schema` -A root level Data Resource descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Data Resource descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/dataresource.json` and the recommended value is `https://datapackage.org/profiles/2.0/dataresource.json`. @@ -190,7 +190,7 @@ The MD5 hash for this resource. Other algorithms can be indicated by prefixing t #### `sources` -List of data sources as for [Data Package](../data-package/#sources). +List of data sources as for [Data Package](../data-package/#sources). If not specified the resource inherits from the data package. #### `licenses` @@ -200,7 +200,9 @@ List of licenses as for [Data Package](../data-package/#licenses). If not specif The properties below are applicable to any Tabular Data Resource. -#### `data` +#### `path` or `data` [required] + +If the `path` property is used for providing data than it `MUST` contain [Tabular Data](../glossary/#tabular-data). If the `data` property is used for providing data for a Tabular Data Resource than it `MUST` be an `array` where each item in the array `MUST` be either: diff --git a/content/docs/specifications/table-dialect.md b/content/docs/specifications/table-dialect.md index a6349a56..27cc26bb 100644 --- a/content/docs/specifications/table-dialect.md +++ b/content/docs/specifications/table-dialect.md @@ -72,7 +72,7 @@ General properties are format-agnostic. Usually, there are useful for defining d #### `$schema` -A root level Table Dialect descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Table Dialect descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/tabledialect.json` and the recommended value is `https://datapackage.org/profiles/2.0/tabledialect.json`. diff --git a/content/docs/specifications/table-schema.md b/content/docs/specifications/table-schema.md index 69aef6ef..5cdec350 100644 --- a/content/docs/specifications/table-schema.md +++ b/content/docs/specifications/table-schema.md @@ -109,7 +109,7 @@ The way Table Schema `fields` are mapped onto the data source fields are defined #### `$schema` -A root level Table Schema descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. +A root level Table Schema descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification. The default value is `https://datapackage.org/profiles/1.0/tableschema.json` and the recommended value is `https://datapackage.org/profiles/2.0/tableschema.json`. diff --git a/content/docs/standard/recipes.mdx b/content/docs/standard/recipes.mdx index 5a3915ca..98805977 100644 --- a/content/docs/standard/recipes.mdx +++ b/content/docs/standard/recipes.mdx @@ -90,18 +90,6 @@ Recipes are various approaches for solving common problems, in ways that are not href="/recipes/external-foreign-keys" /> - - - -