Dear All,
Lately I have read a lot of the beginner’s issues posted here and I found out that we lose a lot of time finding out the real problems that people are trying to solve using this forum.
@rlkoshak, @Udo_Hartmann, @Dim, @rossko57, @sihui, @ThomDietrich and many others (sorry for not mentioning you all) lose a lot of time just finding out step by step what the problem really is (sometimes I have the feeling that we are pulling teeth out of the topic’s creator’s mouth). We lose this time just because the information given is scarce, or even worse in the form (and I am not exaggerating): “openHAB stopped working after restart” with no additional information.
I kindly ask you to take a look at the guide I am trying to describe for beginners’ topic creation and improve it together with me. Maybe the forum platform will later be able to offer templates for issues.
In the beginning, a popup (I don’t know if it’s possible) with this type of guide should suffice when trying to post in the beginners’ category. Later on, guides like this can be extended per add-on, etc.
This is my first draft:
Scenario 1
We assume the poster installed java and then openHAB and he/she has issues with various components
Checklist before creating a beginner topic
You want to create the topic in the Beginners’ category, then you should follow a list of things that have to be checked before topic creation:
- OS platform - here there should be a note on how to find the OS version, etc
- Java platform used - use
java --version
to find out your java environment - openHAB version/release - here there should be a note on how to find the openHAB release using the karaf console
- You read the relevant information at openHAB documentation site.
- You are using Smarthome Designer if textual configuration is involved in the issue. - if Smarthome Designer is not installed, you should follow these steps.
- You should prepare for upload the relevant parts of the conf files (items, rules, sitemap, services) when dealing with textual configuration files.
- You should check the logs for errors - karaf console:
log:tail
Scenario 2
We assume the poster tried to install openHAB and failed installing, starting, or configuring the startup of openHAB as a service.
Checklist before creating a beginner topic
You want to create the topic in the Beginners’ category, then you should follow a list of things that have to be checked before topic creation:
- OS platform - here there should be a note on how to find the OS version, etc
- Java platform used - use
java --version
to find out your java environment - You read the relevant information at openHAB documentation site.
- You have this type of installation used: manual or automatic
- You should check the permissions on the relevant files/services used - here there should be a how to description and what is needed.
If all these points above have been at least in a declarative manner followed by the poster, then we at least have more information than we can expect without this checklist!
It is a starting point, please feel free to contribute. I might be wrong, but I have the feeling that this might be helpful for many beginners that create topics without first checking basic stuff!