Review metadata requirements from NFDI4Energy

[Ludee]

Description of the issue

NFDI4Energy has defined requirements for metadata.
Review all requirements in detail and comment on it.
Goal is to fulfil all requirements.
https://github.com/NFDI4Energy/metadata-requirements/blob/main/non-functional-requirements.md

Ideas of solution

Create a document commenting on all requirements.

Workflow checklist

• I am aware of the workflow in CONTRIBUTING.md

[Ludee]

I added comments to the requirements:
https://github.com/NFDI4Energy/metadata-requirements/blob/feature-222-oemetadata/non-functional-requirements.md
Please revise @vismayajochem

[vismayajochem]

What does ? as comment mean?

• 1. tags -> keywords? Does the howl annotation process under fields play a role into 'Links between metadata records'?
• 4. Where is it documented what fields are mandatory and what are optional? In the meta data key despricption only the badges are listed.
• 5. How formal is this documentation? How improtant/relevant is the info, that nesting is annoying?
• 12. What does 'Protege?' mean?
• 8. forbetter -> for better
• 11. JSOn -> JSON
• 15. Some documentation already exists, no? It just needs to be updated to be compatible with v.2.0
• 16. Is it still beeing developed or why is there no green hook? The badges are there, are the templates not?
• What is with 19. and 20.? Are they so basic, they don't need further explanation?
• 21. for the public available documentation ...
• 24. tags -> keywords?
• XX) 📝Metadata usage documentation shall be understandable for users that need to fill or read metadata: add tutorial https://openenergyplatform.github.io/academy/tutorials/99_other/oemetadata/

[Ludee]

Identified work items:

OEMetadata:

• 🛠 REQ-DESIGN-SCHEMA-FIELD-IMPORTANCE Update documentation with badges.
• 🛠 REQ-USE-SCHEMA-DOCUMENTATION-STAKEHOLDER-USERS Add info from JSON schema to documentation (cardinality, mandatory, badges ..)
• 🛠 REQ-DOCUMENTATION-VERSION-CONTROL mike for documentation versioning
• 🛠 REQ-IMPL-SCHEMA-PROVIDED-FILES JSON schema modules for better maintenance. No turtle yet.
• 🛠 REQ-INTEGRATION-SCHEMA-APPLICATION-REQUIREMENTS Add requirements to the documentation
• 🛠 REQ-METADATA-TOOLING-INTEGRATION Develop templates for different ressources: timeseries, geodata, parameter...
• 🛠 REQ-METADATA-FORMAT-STANDARDS Add RDF. Extend the json-ld context #232
• 🛠 REQ-USE-RECORD-DOCUMENTATION-STAKEHOLDER-USERS Update to 2.0

OMI:

• 🛠 REQ-INTEGRATION-SCHEMA-STANDARD-INTEROPERABILITY Implement mappings and crosswalks in OMI
• 🛠 REQ-STANDARD-EXPORTS Implement crosswalks in OMI.
• 🛠 REQ-DOCUMENTATION-TERMINOLOGY-DIFFERENCES Include SKOS in the metadata crosswalks in OMI.
• 🛠 REQ-CURATED-CONTROLLED-VOCABS Improve workflow!
• 🛠 REQ-USE-RECORD-SIMPLE-UI Feedback wanted.
• 🛠 REQ-METADATA-TOOLING-INTEGRATION Implement mappings in OMI (ongoing development)
• 🛠 REQ-REVIEW-RECORD-FORMAT-VALIDATION Check patterns and licenses.
• 🛠 REQ-METADATA-TOOLING-VALIDATION Implement check licenses, etc.