Include metadata badge description in documentation

OpenEnergyPlatform / oemetadata

Repository for the Open Energy Family metadata. Contains metadata templates, examples and schemas. For metadata conversion see https://github.com/OpenEnergyPlatform/omi

https://openenergyplatform.github.io/oemetadata/

MIT License

21 stars 3 forks source link

Include metadata badge description in documentation #124

Closed jh-RLI closed 9 months ago

jh-RLI commented 1 year ago

Description of the issue

Currently there is no informatioen present about the badge system.

Ideas of solution

[ ] Add section to mkdocs documentation
[ ] Link to section to make documentation visible

Workflow checklist

[ ] I am aware of the workflow in CONTRIBUTING.md

jh-RLI commented 1 year ago

Quality measurement for metadata

All fields listed on a badge must be filled in by the user when creating the metadata (except for automatic fields), if they are present and a validation accepts the entries, the badge is awarded
Automatic fields can be automatically validated and/or filled in.
Other fields require peer review

jh-RLI commented 9 months ago

The badge information is avaialbe with version 1.6 . The automation functionality will be implemented in the oeplatform / omi software.