search

openhab / openhab1-addons

Add-ons for openHAB 1.x
Eclipse Public License 2.0
3.43k stars 1.71k forks source link

[Anel] Update README.md #5766

Closed yveshanoulle closed 5 years ago

yveshanoulle commented 5 years ago

I added the name of the binding that needs to be used in addons.cfg. It helps people if they see the name of to be used in the documentation.

Confectrician commented 5 years ago

Tough it looks ok so far it is also a bit duplicated content. But the relevant docs article is linked aside, so why not.

LGTM

yveshanoulle commented 5 years ago

Duplicated content with what? I found no way to know what the name of the binding was. I was told on the forums that I had to install paperUI to figure out the name of the binding. I thought if I have to look for so long, I can just as well add it to the binding, so others can find that more easily.

9037568 commented 5 years ago

Duplicate content indeed. I say not here.

yveshanoulle commented 5 years ago

I don't understand. Nowhere is the information about what to fill into addons.cfg for a certain binding. so please explain what info is duplicated and show me where it is duplicated. I did find it in any of the documentation. Maybe I added too much context and that is duplicated, right now I don't understand what I have duplicated.

Confectrician commented 5 years ago

https://www.openhab.org/docs/configuration/addons.html#through-configuration-files

Explains how you can find out the id through the url of the addons documentation page.

grafik

Which would lead to the docs page for anel: grafik

What we could do, is change the order of the two identification methods in the installation docs. It is possibly easier to quickly open the addons page to get the id, than doing it via console.

Confectrician commented 5 years ago

Can you link the community thread? Maybe we should clarify this too over there.

yveshanoulle commented 5 years ago

Thanks. I did not see that (or this page has evolved since I used it.) I still worry because this explains how to find info, yet if I'm working with a certain binding that is not mentioned here, I doubt I will come to this page. Adding a binding to addons.cfg is not something I do very often. I remember the last time I needed that, I tried out a few names because the binding did not mention it, and I did not know about this link between url and name of the binding.

I think there are more places where paperui as a solution was mentioned. This was one on a question of me https://community.openhab.org/t/solved-initial-setup-package-selection-using-addons-cfg/43288/2?u=yves

Confectrician commented 5 years ago

I did not see that (or this page has evolved since I used it.)

It was already part of the initial commit done by me in June 2018, but that doesn't matter.

I still worry because this explains how to find info, yet if I'm working with a certain binding that is not mentioned here, I doubt I will come to this page.

You are not the first one to notice this gap. Please have a look at https://github.com/openhab/website/issues/152 where we are already discussing ways to improve this.

yveshanoulle commented 5 years ago

June 2018 I started using addons.cfg before june.