Simplify documentation of datamodels and usage of plugins #977
Conversation
francescalb
changed the title
|
Ønsker du helt å slette avsnittet om datamodeller eller bare forbedre det? |
Also removed many different ways of doing it so that we rather show one and have people use that
No, I had forgotten to push the file. However, I think it smart to now have many different examples which are confusing and rather provide the preferred one (yaml, newer version). |
francescalb
changed the title
doc/user_guide/datamodels.md
Outdated
| dlite-validate | ||
| ============== | ||
| The dlite-validate tool can be used to check if a specific representation (in a file) is a valid DLite datamodel | ||
|
|
||
| This can be run as follows | ||
| ```bash | ||
| dlite-validate filename.yaml # or json | ||
| ``` | ||
|
|
||
| It will then return a list of errors if it is not a valid representation. |
There was a problem hiding this comment.
I think this should be moved to doc/user_guide/tools.md. But it would be great with a note here saying that datamodels can be validated using the dlite_validate tool, with a reference to the correct section in doc/user_guide/tools.md.
There was a problem hiding this comment.
Have you pushed the changes to doc/user_guide/tools.md?
There was a problem hiding this comment.
Not yet, waiting for you answer on teams.
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Co-authored-by: Jesper Friis <jesper-friis@users.noreply.github.com>
Description
I keep having problems with creating my own plugins and datamodels, and there
are so many inconsistent examples around.
I try here to clarify some of the things and add a small section on how to make entities, that is easy to find.
Type of change
Checklist for the reviewer
This checklist should be used as a help for the reviewer.