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

Feedback course 02: How to get started with the Open Energy Family and Platform #164

Open han-f opened 1 year ago

han-f commented 1 year ago

Please review course 02: https://openenergyplatform.github.io/academy/courses/02_start/ and provide your feedback below as comments. Feedback can include pointing out errors (such as broken links, things that do not work as described) any suggestions for, improvements, things that you are expecting from such a course but find they are missing etc.

Please make sure to reference the link to the material that you refer to in your comment (the courses link to various materials)

TilmanKie commented 1 year ago
  1. Maybe I don't have the necessary prior knowledge, but I don't understand the relevance of the API and the API token. After read the introduction I know where I find the API token and I know that "it's necessary to make authenticated requests to the API", but I don't know what the API is and in which case I need it.
  2. At "why register at github?" the "github"-URL doesn't work and the "repositories"-URL goes to a broken website
  3. I think some URL links are too much. For example at "Why register with github?" it's not necessary to link github in my opinion. It's just an explanation why you need github and if you follow the next steps you'll get to the github website anyway.
  4. I like that every step is detailed explained. It's explained why this step is necessary and what you have to do
TilmanKie commented 1 year ago

And at the first point "For whom is this training and what can you learn?" the grammar of the first sentence makes no sense: "After reading the sections of this training course you will ... wants to interact as a user with the OEP. I don't think it's that important but I thought I'd tell you :)

han-f commented 1 year ago

Many thanks @TilmanKie for the feedback, I will create issues from your findings and address them.

han-f commented 1 year ago

168, #169