OpenEnergyPlatform / OpenEnergyPlatform/oeplatform
[OEMetadata] The Resource Section of the meta information need improvement
Open
@jh-RLI is already working on this.
Since Oct 18, 2024.
bug
design/layout
meta Information
- Dominant language
- Python
- Stars
- 65
- Forks
- 29
- Avg merge
- 15h 25m
- Merged PRs (30d)
- 32
Description
Description of the issue
The resource section with descriptions of the column names needs improvements:
Ideas of solution
Rearrange the keys:
- Name
- Description
- Unit (Only show if available)
- Type
- Nullable (Only show if False)
- Is About (Only show if available)
- Value Reference (Only show if available)
The first three are about the content.
Type and Nullable are technical keys.
Is About and Value Reference are annotations.
Adjust the frontend. e.g. put the annotations to the right into a box.
In general a table view would be suitable for this section.
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.