Beginners Guide: How to upload data to the OpenEnergy Platform and initiate the review process not up to date

[vismayajochem]

Description of the issue

• 1. In section 1 the screenshots don't represent the current design of the web pages. (see also comment on issue Pictures for Login are not shown in Guidebook - How to Publish Your Data on the OEP  #220) The picture for the registration to OEP and the screenshot with the information as well as the screenshot of the contact form don't look like the webside currently looks like.

• 2. In section 2.1 the reader is asked to jump to 2.1.4 but cannot do so because there is no link implemented to jump to set section. In the sentence before 'section 2' has also no link implemnted so the reader can easily jump there.

• 3. In section 2.1 the link requests package gives an error message.

• 4. In section 2.2 the linked file github can not be found.

• 5. in section 2.2 in one sentence the grammar is not fully correct: Once your data table(s) have been uploaded to model_draft schema on the OpenEnergy Platform...

Steps to Reproduce

3./4. Click on the link

Ideas of solution

1. Make new screenshots and implement them correctly.
2. Either also have the verb in singular form (has) or decide to write the whole sentence either in singular or in plural form. E.g. Once your data table(s) has(have) been uploaded to model_draft schema on the OpenEnergy Platform...

Context and Environment

• Version used:
• Operating system:
• Environment setup and (python) version:

Workflow checklist

• I am aware of the workflow in CONTRIBUTING.md

[vismayajochem]

In the course 02 - How to get started with the Open Energy Family and Platform the first steps are quite nicely described and have the exact same content. So section How do I get started with the OEP? in the course and 1.1. Register at the OpenEnergy Platform describe the same processes, while the first one represents the current design of the OEP and is formulated nicely and easy to understand, while the second one isn't.
Same goes for the following sections regarding github.
I don't know if here redundance is a good thing and the best solution is to copy the sections from the course to the tutorial guidebook, or if it makes more sence to link the course in the tutorial.

[han-f]

I have deleted / changed the screenshots in Section 1. I left the contact form screenshot as is for now, as the layout does not seem essential here.

[flohrreija-oeko]

Feedback on non-working links of this tutorial:

1. In section 2.1 the link requests package gives an error message
2. In section 2.1 the link verb (get, post, put, delete) gives en error message
3. In section 2.2 the linked file github can not be found

[han-f]

@wingechr - could you please check alternatives for the first to link problems? Merci
I fixed point 3. - as I reworked Section 2.2

[flohrreija-oeko]

General feedback:

1. In the code in section 2.1 there are some parts of the code missing for the code to run (that are later included in the full code but created some confusion if you follow the tutorial step by step) e.g. define API_TOKEN='yourAPITOKEN', import all needed packages
2. In section 2.1.1 it was not clear to me that I first need to define the variable table_name=’insert table name’ first explicitly in the code line (again this is included in the full code)
3. In section 2.1.1 the codeline url = API_URL + '/topic/model_draft/tables/' + TABLE_NAME does not work as + ‘/’ is missing (in the full code it works)
4. For clarity when following the full tutorial for the first time include a clarification sentence at the beginning of section 2.1.2 Once you have created a new table in the model_draft (step 2.1.1) you can upload data into that table
5. In section 2.1.2 clarify that the variables WORKBOOK and WORKSHEET need to be defined first (again, in the full code this is done)
6. Section 2.1.4 with the example code is super good and helpful (probably the most helpful of the whole course for me)

[jh-RLI]

I also noticed that the API URL contains "topic". I haven't tested this yet, but it shouldn't work like this. We wanted to change this once, but didn't have the time to do so.

The correct url should use "schema":

In the code snippet in section 2.1.1 it reads “…/topic/…”:

url = API_URL + '/topic/model_draft/tables/' + TABLE_NAME

it should be “schema”

url = API_URL + '/schema/model_draft/tables/' + TABLE_NAME

This seems to be a issue that is present in other sections also.