OpenEnergyPlatform / OpenEnergyPlatform/oeplatform
OEMetaBuilder: Add links to the metadata schema
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 65
- Forks
- 29
- Avg merge
- 15h 25m
- Merged PRs (30d)
- 32
Description
Description of the issue
Currently when using the OEMetaBuilder, if a term is unclear or more guidance is needed to fill out a field, the best solution is to go directly to the OEMetadata schema, which has more detailed term definitions as well as examples of what the content of a field should look like.
There are also instances where the field instructions direct the user to visit a different website for information. Specifically, in the "Licenses" section, under "Instruction" the informational text says "A short description of rights and restrictions. The use of tl;drLegal is recommended." No indication is given here that tl;drLegal is a different website that the user should visit to get more info; the metadata schema does provide a link to the tl;drLegal website, but the OEMetaBuilder form does not.
Ideas of solution
Add links in the OEMetaBuilder so that a user can click on a field name to pull up the field's definition in the metadata schema. Also, add a link to tl;drLegal directly in the form.
Workflow checklist
- I am aware of the workflow in CONTRIBUTING.md
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.