Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
han-f opened this issue Apr 12, 2023 · 6 comments
Labels

Comments

@han-f
Copy link
Contributor

han-f commented Apr 12, 2023

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
Copy link

  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
Copy link

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
Copy link
Contributor Author

han-f commented Apr 14, 2023

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

@han-f
Copy link
Contributor Author

han-f commented Apr 14, 2023

#168, #169

@Ludee Ludee added help wanted Extra attention is needed documentation labels Jun 14, 2023
@Ludee Ludee changed the title Feedback Course 02: How to get started with the Open Energy Family and Platform Feedback course 02: How to get started with the Open Energy Family and Platform Jun 14, 2023
@flohrreija-oeko
Copy link
Collaborator

There is already an Introduction to github in Section 3 of Course 05 "The Open Energy Ontology" which could be refered to and linked in the Section "Why register with github" in this Course.

@han-f
Copy link
Contributor Author

han-f commented Jul 17, 2024

Thanks @flohrreija-oeko, I have added the following sentence at the end of the course:
We collected a few links to GitHub and git basics here for your first steps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants