[hueemulation] Update README.md

[pmknowles]

It's not clear where the tag needs to be applied

[cweitkamp]

Isn't the syntax clearly described in the docs? I'd vote for not putting it into the documentation of a binding.

[pmknowles]

So I went to the docs

Tagging is a new feature and only a few I/O add-ons have implemented it. The easiest way to determine if tags have been implemented in a specific add-on is to see if the add-on documentation explicitly discusses their usage. Tags will be ignored if no Items in the openHAB installation support it.

See the Hue Emulation or HomeKit Add-on documentation for more details.

The link in the docs to Hue Emulation and the HomeKit gives 404 which doesn't help. My point was that the example doesn't show where to put the tag. You may be able to remember the syntax but I am not constantly adding items.
One of the frustrations of openHAB is the examples are often written by people who understand the systems really well. Something that is blindingly obvious to them isn't necessarily obvious to someone less experienced.
I'm suggesting an improvement to the example not rewriting the readme

[cweitkamp]

Alright, I got your point. Let's add the information in a short version.

I fixed the links in the docs (see openhab/openhab-docs#819). After a new website deployment the will work again.

[davidgraeff]

Why not changing one of the existing example items with the explanation sentence. People will figure this out.

[pmknowles]

In my request I proposed an example before and after the tag is added. It took me half a day to work out why it wasn't working. In the main docs it says that tagging is relatively new and explicit explanations will be given in bindings etc using tags. When I used to write Operation and Maintenance Manuals we always passed them to someone uninvolved in the project for them to assess whether they made sense to fresh person. I think openHAB could look for volunteers to review documentation prior to publication. I, for one, would be happy to help with that. Get Outlook for Android<https://aka.ms/ghei36>

…

________________________________ From: David Gräff <[email protected]> Sent: Monday, December 3, 2018 3:30:13 AM To: openhab/openhab2-addons Cc: pmknowles; Author Subject: Re: [openhab/openhab2-addons] [hueemulation] Update README.md (#4282) @davidgraeff commented on this pull request. Why not changing one of the existing example items with the explanation sentence. People will figure this out. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub<https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.jparrowsec.cn%2Fopenhab%2Fopenhab2-addons%2Fpull%2F4282%23pullrequestreview-180604827&data=02%7C01%7C%7Caab5039e83044736198f08d658cfa370%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636794046147607915&sdata=37iOQfr8lTju1m0g8%2BqllgAFqOWk7fVdYO5e4jLuWIw%3D&reserved=0>, or mute the thread<https://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.jparrowsec.cn%2Fnotifications%2Funsubscribe-auth%2FAjqns-lAh2enG6V4dVBw-zi3xB6woCWeks5u1JrFgaJpZM4Yymii&data=02%7C01%7C%7Caab5039e83044736198f08d658cfa370%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636794046147607915&sdata=lkCvgAobS%2B8uZzYrrdYY4D9MOpBV2pwlOOvhjZOmsh0%3D&reserved=0>.

[cweitkamp]

@pmknowles Your help is very much appreciated. I like the proposal of @davidgraeff. Wdyt?

I think openHAB could look for volunteers to review documentation prior to publication. I, for one, would be happy to help with that.

Yes, of course. We are always looking for help. Please have a look into the docs repo or contact @Confectrician directly for more information.

[davidgraeff]

In the long run hopefully the majority can just use Paper UI for assigning tags etc.
My suggestion is to change one of the given examples, maybe with a shorter configuration than mqtt_1. A short config would be a typical OH2 addon config where just the destination "channel" is given.

[cweitkamp]

@pmknowles Any news on this?

[wborn]

I've addressed the review comments @cweitkamp!

[Confectrician]

LGTM

[cweitkamp]

LGTM. Thanks.

@davidgraeff wdyt? Shall we now leave it like it is or shall we incorporate your suggestions too?

[davidgraeff]

There are all kind of examples added to the binding docs at the moment, I see this in my bindings at least.
This is not scale-able nor does it make sense if we indeed replace the .things/.items file syntax at some point. But for now I just approve all of those additions.