OpenEnergyPlatform / OpenEnergyPlatform/oeplatform

[OEMetadata] The Resource Section of the meta information need improvement

Open
#1,892 1 comment 0 reactions 2 assignees View on GitHub

@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:

grafik

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.