search

openhab / openhab1-addons

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

[TCP Binding] Enhancements for README.md #5710

Closed arberg closed 5 years ago

arberg commented 5 years ago

Signed-off-by: Alex R. Berg, developlantern@gmail.com, github: arberg

Better example, info that its broken with links, added unclear stuff - strange to have in wiki, but better than leaving user in wilderness I believe. Lets just be honest, if somebody knows what it means and feels like specified that would be great.

openhab-bot commented 5 years ago

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/tcp-binding-multiple-items-from-single-ip-port/36490/6

openhab-bot commented 5 years ago

This pull request has been mentioned on openHAB Community. There might be relevant details there:

https://community.openhab.org/t/wiki-update-failed-automatic-jenkins-tests/56968/1

arberg commented 5 years ago

Hi Chris,

That is a lot of edits you have requested. It is a very slow and heavy process, if I am to understand what you mean, locate it manually and then apply the edit, and hope I got it all. I don't seem to be able to find an 'apply' button for the comments, probably because they are just comments. I also havn't found a nice side by side review, and when I checked out my fork of the main-repo, my changes to the readme wasn't there, so can use intellij/sourcetree to view changes.

I enjoy sharing what I have learned so others don't have to go through the same debugging process reviewing 10s of other peoples questions on community forum discussing the seemingly same isuses. I also like clarifying missing examples etc. But its gotta be quick for me, otherwise I won't do it.

I don't mind you editting my edits, just delete what you don't like, and edit what you do. I can review your review, if needed.

I can also post this on community forum if you wish.

I figured I might go over the other docs where I had trouble getting it to work, such as network binding ping, and mqtt broker, if it was super easy for me.

Regarding the 'broken' stuff: I personally find it more helpful to have more information. It makes sense to label it 'known issues'. In my book, its bad for publicity to claim something works, and then when people poke around there are issues everywhere. I'm new to openHab, and might not even stay because the getting started has been fraught with weird behaviours, like even a simple ping didn't work out-of-the-box. But I do absolutely love the rule language and the power openHAB gives, which I suspect is not quite there for Home Assistent. My message being: Lets make it easy on new users, by giving them the info they need where they look for it, if possible. Going over community forums for known issues that nobody seems to 'own' is a lot of work. Like if TCP binding sucks stability wise, we can show them MQTT and make MQTT doc really good.

Best Alex

9037568 commented 5 years ago

But its gotta be quick for me, otherwise I won't do it.

I get the picture. I'll leave this open for a while just in case you decide to spend a few seconds on it.

arberg commented 5 years ago

Hi Chris, I figured out GitHub kept the changes in a branch, so I could pull that and edit locally. That helped a bit with diffing and applying changes. I have added/updated with most of your comments. I may have missed some given the nature of the task. I chose not to follow your guideline regarding breaking the syntax (line 47) into two examples for IN and OUT. I kept it this way to avoid duplicating the explanations. I now see you probably meant replace '' with '<'. I still don't think that help much. Instead I have improved much upon the examples, splitting those into IN and OUT. I elaborate the difference between direction IN/OUT and command/update (data in/out). Its very easy to get confused, I certainly was and was mislead by other confused people on the forum.

If you want find minor edits and its easy to do, please feel free to just make the edits, and send me the whole changed file, and just leave inline comments for bigger things, if any.

I can of cause delete the section on known isuses and alternative solutions, but I'm quite sure that would not help the adopters of OpenHAB.

Best Alex

9037568 commented 5 years ago

Thanks, @arberg !