Remove links to no longer existing apcupsd documentation#36378
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request involves updating the documentation for the APC UPS Daemon (apcupsd) integration in Home Assistant. The changes are focused on simplifying the text description and removing a specific reference to the Network Information Server (NIS) configuration. The modifications aim to improve the readability of the documentation without altering the core technical information about the integration. Changes
Assessment against linked issues
The changes appear to address the broken link issue by removing the specific reference and associated hyperlink, which was likely causing the link to be non-functional. The documentation has been streamlined without losing the essential information about the APC UPS Daemon integration. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/apcupsd.markdown(2 hunks)
🔇 Additional comments (1)
source/_integrations/apcupsd.markdown (1)
Line range hint 1-143: Verify no other references to the apcupsd website exist
Let's verify there are no other references to the apcupsd website in the documentation.
✅ Verification successful
Two instances of apcupsd.org link found, both are valid and necessary
The verification found exactly two instances of the apcupsd.org link in the documentation:
- First instance: In the introduction to explain what apcupsd is
- Second instance: In the connection troubleshooting note to guide users to the configuration directives
Both links serve distinct purposes and are appropriately placed in the documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for any remaining references to apcupsd.org in the documentation
rg -i "apcupsd\.org" source/_integrations/
Length of output: 594
| {% note %} | ||
|
|
||
| If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses [NISIP 0.0.0.0](http://www.apcupsd.org/manual/manual.html#configuration-directives-used-by-the-network-information-server), else non-local addresses will not connect. | ||
| If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses NISIP 0.0.0.0, else non-local addresses will not connect. |
There was a problem hiding this comment.
Remove the remaining link to apcupsd website
Similar to the previous instance, the link to http://www.apcupsd.org/ should be removed while retaining the important configuration information about NISIP.
Here's the suggested change:
-If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses NISIP 0.0.0.0, else non-local addresses will not connect.
+If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the apcupsd configuration directives used by its Network Information Server is set to permit connections from all addresses NISIP 0.0.0.0, else non-local addresses will not connect.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the [apcupsd](http://www.apcupsd.org/) configuration directives used by its Network Information Server is set to permit connections from all addresses NISIP 0.0.0.0, else non-local addresses will not connect. | |
| If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, ensure the apcupsd configuration directives used by its Network Information Server is set to permit connections from all addresses NISIP 0.0.0.0, else non-local addresses will not connect. |
| --- | ||
|
|
||
| [apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver) on the APC device. | ||
| [apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) is configured on the APC device. |
There was a problem hiding this comment.
Remove the remaining link to apcupsd website
The PR aims to remove links to the no-longer-existing apcupsd documentation, but the link to http://www.apcupsd.org/ is still present in this line. Since the website is no longer available, this link should be removed.
Here's the suggested change:
-[apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) is configured on the APC device.
+apcupsd status information can be integrated into Home Assistant when the Network Information Server (NIS) is configured on the APC device.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [apcupsd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) is configured on the APC device. | |
| apcupsd status information can be integrated into Home Assistant when the Network Information Server (NIS) is configured on the APC device. |
Proposed change
Removes links to the apcupsd website/documentation. The website no longer exists (neither does the documentation). The upstream project has no alternative available.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit