Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Commit

Permalink
Improved changelog structure (#60)
Browse files Browse the repository at this point in the history
* Present Table Schema changelog as a list

* Move up headings and present Table Schema as headings

* Update changelog structure for Table Schema (#59)

* Present Table Schema changelog as a list

* Move up headings and present Table Schema as headings

* End language section with period

* Use titlecase for author name

* Correct tick for MUST NOT

* Use h5 headers

* Clarify and correct some Table Schema changes

* Document Data Resource and Table Dialect changes

* Correct description for givenName/familyName

* Redocument Data Package

* Order changes following the order they appear in the spec

* Shorten titles

* Bundle changes for contributors and contributors

---------

Co-authored-by: Peter Desmet <[email protected]>
  • Loading branch information
roll and peterdesmet authored May 7, 2024
1 parent a390ca7 commit 6d14837
Show file tree
Hide file tree
Showing 9 changed files with 68 additions and 107 deletions.
2 changes: 1 addition & 1 deletion content/docs/recipes/relationship-between-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Relationship between Fields
<table>
<tr>
<th>Authors</th>
<td>Philippe THOMY, Peter Desmet</td>
<td>Philippe Thomy, Peter Desmet</td>
</tr>
</table>

Expand Down
6 changes: 3 additions & 3 deletions content/docs/specifications/data-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A simple container format for describing a coherent collection of data in a sing

## Language

The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)
The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

## Introduction

Expand Down Expand Up @@ -221,8 +221,8 @@ An Array of string keywords to assist users searching for the package in catalog
The people or organizations who contributed to this Data Package. It `MUST` be an array. Each entry is a Contributor and `MUST` be an `object`. A Contributor `MUST` have at least one property. A Contributor is `RECOMMENDED` to have `title` property and `MAY` contain `givenName`, `familyName`, `path`, `email`, `roles`, and `organization` properties:

- `title`: A string containing a name of the contributor.
- `givenName`: A string containing name a person has been given, if the contributor is a person.
- `familyName`: A string containing familial name that a person inherits, if the contributor is a person.
- `givenName`: A string containing the name a person has been given, if the contributor is a person.
- `familyName`: A string containing the familial name that a person inherits, if the contributor is a person.
- `path`: A fully qualified URL pointing to a relevant location online for the contributor.
- `email`: A string containing an email address.
- `roles`: An array of strings describing the roles of the contributor. A role is `RECOMMENDED` to follow an established vocabulary, such as [DataCite Metadata Schema's contributorRole](https://support.datacite.org/docs/datacite-metadata-schema-v44-recommended-and-optional-properties#7a-contributortype) or [CreDIT](https://credit.niso.org/). Useful roles to indicate are: `creator`, `contact`, `rightsHolder`, and `dataCurator`.
Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/data-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A simple format to describe and package a single data resource such as a individ

## Language

The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)
The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

## Descriptor

Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The Data Package Standard extensibility features for domain-specific needs.

## Language

The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)
The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

## Introduction

Expand Down
4 changes: 2 additions & 2 deletions content/docs/specifications/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A dictionary of special terms for the Data Package Standard.

## Language

The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)
The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

## Definitions

Expand Down Expand Up @@ -74,7 +74,7 @@ A `URL or Path` is a `string` with the following additional constraints:

- `MUST` either be a URL or a POSIX path
- [URLs](https://en.wikipedia.org/wiki/Uniform_Resource_Locator) `MUST` be fully qualified. `MUST` be using either http or https scheme. (Absence of a scheme indicates `MUST` be a POSIX path)
- [POSIX paths](https://en.wikipedia.org/wiki/Path_%28computing%29#POSIX_pathname_definition) (unix-style with `/` as separator) are supported for referencing local files, with the security restraint that they `MUST` be relative siblings or children of the descriptor. Absolute paths `/`, relative parent paths `../`, hidden folders starting from a dot `.hidden` `MUST` NOT be used.
- [POSIX paths](https://en.wikipedia.org/wiki/Path_%28computing%29#POSIX_pathname_definition) (unix-style with `/` as separator) are supported for referencing local files, with the security restraint that they `MUST` be relative siblings or children of the descriptor. Absolute paths `/`, relative parent paths `../`, hidden folders starting from a dot `.hidden` `MUST NOT` be used.

Example of a fully qualified url:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Security considerations around Data Packages and Data Resources.

## Language

The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)
The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

## Usage Perspective

Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/table-dialect.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Table Dialect describes how tabular data is stored in a file. It supports delimi

## Language

The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)
The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

## Introduction

Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/table-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A simple format to declare a schema for tabular data. The schema is designed to

## Language

The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt)
The key words `MUST`, `MUST NOT`, `REQUIRED`, `SHALL`, `SHALL NOT`, `SHOULD`, `SHOULD NOT`, `RECOMMENDED`, `MAY`, and `OPTIONAL` in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt).

## Introduction

Expand Down
Loading

0 comments on commit 6d14837

Please sign in to comment.