search

co-cddo / ukgov-metadata-exchange-model

A metadata model for describing data assets for exchanging between UK government organisations.
https://co-cddo.github.io/ukgov-metadata-exchange-model/
Other
13 stars 1 forks source link

Add usage notes for version property #45

Closed AlasdairGray closed 11 months ago

AlasdairGray commented 11 months ago

There are no usage notes for the version property.

This is a mandatory property but not all suppliers version their data assets.

Usage notes should be added to help metadata suppliers to understand what values to provide in these cases.

AlasdairGray commented 11 months ago

On the data marketplace manually publish a data asset we show the following guidance

For example: v1.0, v2.0, v3.0 or release date. If this is the first or only version, put v1.0 or the date of release in the format yyyy-mm-dd.

AlasdairGray commented 11 months ago

Draft text for this has been made on branch https://github.com/co-cddo/ukgov-metadata-exchange-model/tree/issue45-version-guidance. The screenshot below show what the current text looks like when deployed.

@cyberdudeuk if you are happy with this, then I'll change it into a pull request. Otherwise please suggest changes to the text

The value of this field should follow the versioning scheme for the data asset. This could use semantic version or some date based approach.

If a versioning scheme has not been chosen, or this is the first or only version, put v1.0 or the date of release in the format yyyy-mm-dd.

Screenshot 2023-10-25 at 15 17 10

cyberdudeuk commented 11 months ago

That looks like a sensible approach, pls go ahead and PR it, thxs

AlasdairGray commented 11 months ago

PR created and ready for your review.