search

OpenEnergyPlatform / academy

The Open Energy Academy is a collection of courses, tutorials, and questions for the Open Energy Family
https://openenergyplatform.github.io/academy/
GNU Affero General Public License v3.0
16 stars 6 forks source link

Metadata documentation suggestion #56

Closed han-f closed 3 years ago

han-f commented 5 years ago

The current metadata documentation holds examples for the specific entries which is useful. It would be helpful to also have a list of allowed column data types. This applies to the case for working with the API.

han-f commented 4 years ago

Now I found it here: https://github.com/OpenEnergyPlatform/examples/wiki/Metadata-Description It would be helpful to link to this at a prominent place on the OEP. Linked to ticket https://github.com/OpenEnergyPlatform/oeplatform/issues/411

Bachibouzouk commented 4 years ago

The metadata documentation will be moved to https://github.com/OpenEnergyPlatform/metadata

MGlauer commented 4 years ago

Shouldn't we move this issue then?

Bachibouzouk commented 4 years ago

Shouldn't we move this issue then?

@MGlauer - This is my plan (for all metadata issues), but I wanted to wait enough time so that @han-f (or other users) can know that the issues with metadata will be moved :)

christian-rli commented 4 years ago

The documentation has moved to the metadata repository and the allowed data types are available in a json schema here - thank you for the good work @4lm .

A link to the description at a prominent location will be implemented with the redesign, but as you mentioned, this is called for in another issue. Can this issue be closed @han-f ?