OpenEnergyPlatform / OpenEnergyPlatform/academy
Improvements for Tutorial How to generate database conform data?
Open
@christian-rli is already working on this.
Since Jun 10, 2024.
bug
SIROP-WP3
- Dominant language
- Jupyter Notebook
- Stars
- 20
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Description of the issue
There could be done a few improvements on the tutorial How to generate database conform data? (https://openenergyplatform.github.io/academy/tutorials/99_other/database_data/):
- The general formatting is off (word wraps (Zeilenumbruch) are missing, inconsistent use of a., b., c., .... and i, ii, ...).
- There are some links missing. E.g. to the "good example" and the "poor example".
- The quality of the screenshots of the examples is quite poor, so the text is only hardly readable.
Steps to Reproduce
Ideas of solution
- Make it consitent and add word wraps
- Implement links
- If possible use new screenshots with higher resolution or generally better quality
Context and Environment
- Version used:
- Operating system:
- Environment setup and (python) version:
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.