home-assistant / home-assistant.io

:blue_book: Home Assistant User documentation
https://www.home-assistant.io
Other
5.03k stars 7.32k forks source link

Documentation Not Available Where Advertised #35055

Open TransRapid opened 1 month ago

TransRapid commented 1 month ago

Feedback

Your documentation here says to follow instructions on the plugin, yet the plugin does not have any instruction outside of:

"The RTSPtoWebRTC integration requires a server to translate RTSP streams into WebRTC. Enter the URL to the RTSPtoWebRTC server."

URL

https://www.home-assistant.io/integrations/rtsp_to_webrtc/

Version

2024.10.0

Additional information

No response

home-assistant[bot] commented 1 month ago

Hey there @allenporter, mind taking a look at this feedback as it has been labeled with an integration (rtsp_to_webrtc) you are listed as a code owner for? Thanks!

Code owner commands Code owners of `rtsp_to_webrtc` can trigger bot actions by commenting: - `@home-assistant close` Closes the feedback. - `@home-assistant rename Awesome new title` Renames the feedback. - `@home-assistant reopen` Reopen the feedback. - `@home-assistant unassign rtsp_to_webrtc` Removes the current integration label and assignees on the feedback, add the integration domain after the command. - `@home-assistant add-label needs-more-information` Add a label (needs-more-information) to the feedback. - `@home-assistant remove-label needs-more-information` Remove a label (needs-more-information) on the feedback.
allenporter commented 1 month ago

Yes it links to the server in the first paragraph. This integration does not explain how you set up that server, the upstream project is responsible for that.

But to your point, this is not easy. This integration will be deprecated and replaced with go2rtc running in home assistant core. You can use the go2rtc server in the mean time which has better documentation.

TransRapid commented 1 month ago

Thanks for the quick reply. I set up Go2RTC. Very simple yet functional web interface which was great. I was really thrown off by the different modules. I have no issue setting it up, I usually end up compiling everything myself for photo and media services I host. I just was thrown off as to why there were both, especially when I did not see an option to add an RTSP stream to Go2RTC.