Skip to content
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.

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

Metadata changes (v0.4) #241

Merged
merged 22 commits into from
Oct 10, 2022
Merged

Metadata changes (v0.4) #241

merged 22 commits into from
Oct 10, 2022

Conversation

peterdesmet
Copy link
Member

@peterdesmet peterdesmet commented Oct 3, 2022

This PR includes a lot of work:

Changes to Camtrap DP

Textual changes to the metadata page

  • Use a stable version of the website theme
  • Use a sans-serif font for the website
  • Use a consistent order for property elements (name, description, skos, ...). Part of Textual updates #242
  • Remove broken link to example
  • Show an automatically build Table of content on the side, rather than manually maintaining anchors or a table in metadata.md. This does require all properties to be listed in camtrap-dp-profile.json, including the ones we are not extending in Camtrap DP. I think that is a good thing, since you can now see everything in context. For those properties, I added only added a description, which links to the generic specs + allows to clarify some things (Document package$title #233)
"title": {
  "description": "See [Data Package specification](https://specs.frictionlessdata.io/data-package/#title). Not to be confused with the title of the project that originated the package (`package.project.title`)."
},
  • Extend the example data package to include all relevant properties and serve as a better example

  • Have a distinct logical order for the metadata properties. This is mainly based on how properties are listed in a Zenodo metadata page:

    • resources
    • profile *
    • name
    • id
    • created *
    • title
    • contributors *
    • description
    • version
    • keywords
    • image
    • homepage
    • sources
    • licenses
    • bibliographicCitation
    • project *
    • coordinatePrecision
    • spatial *
    • temporal *
    • taxonomic *
    • relatedIdentifiers
    • references
  • Show deep controlled vocabs Mention vocabs for captureMethod, animalTypes on website #226

  • Show const values

  • Show all constraints together (including on "Data") page:

Screenshot 2022-10-05 at 15 27 58

- List them as table on metadata page
- Update profile to list properties in same order
- Update example and include all properties
  - title
  - description
  - version
  - keywords
  - image (empty)
  - homepage (empty)
  - rightsHolder
  - bibliographicCitation
  - references (empty)
- Fix incorrect link to 0.2
Fix #230, update example to make use of this + add coordinateUncertainty
Fix #230, update example to make use of this + add coordinateUncertainty
- Requires every property to be added to camtrap-dp-profile.json, with a description
- Done for data and metadata
- Includes:
  - constraints.required
  - constraints.minimum
  - constraints.maximum
  - constraints.unique
  - constraints.enum
  - const
  - enum
  - items.enum

Fix #226
- Reference terms in `backticks`
- Use "package", not Data Package
- Move examples below type (in profile)
- Refer to other fields via table.fields

t
Closes #27

- Add custom property `version`, but see suggestion to include in main specs: frictionlessdata/datapackage#808
- Update example
@peterdesmet peterdesmet marked this pull request as ready for review October 5, 2022 13:39
@peterdesmet peterdesmet changed the title Metadata changes Metadata changes (v0.4) Oct 5, 2022
@peterdesmet peterdesmet requested a review from kbubnicki October 5, 2022 13:39
@peterdesmet
Copy link
Member Author

The full metadata page now looks like this:

Metadata-Camtrap-DP

@peterdesmet peterdesmet added this to the 1.0 milestone Oct 5, 2022
@peterdesmet peterdesmet added documentation Improvements or additions to documentation level:package labels Oct 5, 2022
@kbubnicki
Copy link
Contributor

Impressive work @peterdesmet!

@peterdesmet peterdesmet merged commit 36984a4 into main Oct 10, 2022
@peterdesmet peterdesmet deleted the metadata_changes branch October 10, 2022 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

2 participants