-
Notifications
You must be signed in to change notification settings - Fork 7.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create zigbee.markdown as start of Zigbee documentation #10585
Conversation
Creating zigbee.markdown as a start of a ZHA documentation even if it is almost only a placeholder. The base of this Zigbee text was mainly copied from the Z-Wave documentation for Home Assistant. The purpose of this is just to get Zigbee into the main documentation that anyone can build on. Ping @dmulcahey @Adminiuga & @damarco for feedback request on this documentation content. PS: This PR is for the 'current' branch and replaces home-assistant#10582 which was based on the 'next' branch.
…current branch) Adding a link for zigbee.markdown (starter Zigbee doc) to index.markdown. Depends on home-assistant#10585 being accepted first. The purpose is to expose the Zigbee Home Assistant integration and show in the same light as the Z-Wave integration. I hope that this will help the existing Zigbee integration become more of a first-class citizen in Home Assistant, just like the existing Z-Wave integration already is. One of the reasons for me creating a separate PR for this from home-assistant#10585 is to give you the option of accepting that and rejecting this index PR if you so wish. As a non-developer, I also currently am not good enough with Git to edit two separate files (using GitHub web interface to edit and create files) :P PS: This PR is for the 'current' branch and replaces home-assistant#10583 which was based on the 'next' branch.
Adding a link for zigbee.markdown (starter Zigbee doc) to index.markdown (current branch). The purpose is to expose the Zigbee Home Assistant integration and show in the same light as the Z-Wave integration. I hope that this will help the existing Zigbee integration become more of a first-class citizen in Home Assistant, just like the existing Z-Wave integration already is.
My initial thought with this is: We should not do this. Reason for this is:
I think this is just a little too soon. We should definitely revisit parts of the website & documentation, which should start at revisiting our general documentation and website structure. From that point of view, I don't think Z-Wave or Zigbee is a first-class citizen for the website, "Protocols": maybe. |
Redirect was miss when copied from Z-Wave documentation
@frenck last section covers some non-native alternative ways of controlling Zigbee devices from HA. "Other than using the above described native Zigbee Home Automation integration in Home Assistant, there are also other integrations for Home Assistant connect a third-party bridge, hub or gateway (that can be hardware or software) which in turn can also communicate with Zigbee devices, through those other integrations mostley or fully absract the fact that the devices are using the Zigbee specification (as such that the devices could just as well be using any other specification). Such integrations with third-party bridges, hubs and gateways that can also communicate with Zigbee devices include but are not exclusive to; deCONZ, Zigbee2mqtt, Philips Hue Hub, Ikea Tradfri Gateway, Osram Lightify, and Samsung SmartThings Hub." You could directly compare this to the fact that it is as far as I could see no mentions in the Z-Wave documentation that controlling Z-Wave devices is also possible through non-native integration with third-party bridges, hubs and gateways. Therefore this Zigbee documentation is possibly fairer by at least listing other options. ...though see now that I drive that point further could have also listed the Wink Hub 2 as the Wink integration is another third-party bridge/hub/gateway solution that abstracts Zigbee and Z-Wave devices. Point is that none of those other integrations let you connect a Zigbee USB stick to a computer running Home Assistant, which is what in my options makes the Zigbee Home Automation integration comparable to the existing Z-Wave integration in Home Assistant, and is why I feel that it deserves to be documented and highlighted on Home Assistant website in the same way as Z-Wave currently already is. Anyway, going from https://www.home-assistant.io/docs/ Z-Wave looks like a first-class on HA website. |
You are missing my point. The point is that the current structure (including Z-Wave) is not good IMHO. That is why I don't feel like we should extend that in that way. This has nothing to do with any class of citizenship. |
I'm with @frenck on this. We should review the structure first. A while back we decided to move Z-Wave and MQTT away from the integration documentation to the "Docs" section. The reason was that both integration provided a huge amount of details which made the integration documentation a pain to read. Also, it was confusing for users to see that much information which was not relevant for their use case. |
Thanks for providing the second opinion on this matter, fabaff. So I'm going to close this, for now, let's revisit this in the future. Nevertheless, @Hedda, thank you for your contribution! That is appreciated. |
Description:
Creating zigbee.markdown as a start of a ZHA documentation even if it is almost only a placeholder.
The base of this Zigbee text was mainly copied from the Z-Wave documentation for Home Assistant.
My purpose of this is to at least get some information about the existing Zigbee Home Automation integration into the main documentation as I think that this could be used as a base and a start for other technical writers who can build on this and help improve the Zigbee documentation for Home Assistant.
With this, I also wish to expose the existing Zigbee Home Assistant integration and show it in the same light as the existing Z-Wave integration. I hope that this will help the existing Zigbee Home Assistant integration become more of a first-class citizen in Home Assistant, just like the existing Z-Wave integration already is.
Ping @dmulcahey @Adminiuga & @damarco for feedback request on this documentation content.
PS: This PR is for the 'current' branch and replaces #10582 which was based on the 'next' branch.
Checklist:
next
is for changes and new documentation that will go public with the next Home Assistant release. Fixes, changes and adjustments for the current release should be created againstcurrent
.