Skip to content

Remove links to no longer existing apcupsd documentation#36378

Merged
c0ffeeca7 merged 1 commit into
currentfrom
frenck-2024-0644
Dec 16, 2024
Merged

Remove links to no longer existing apcupsd documentation#36378
c0ffeeca7 merged 1 commit into
currentfrom
frenck-2024-0644

Conversation

@frenck
Copy link
Copy Markdown
Member

@frenck frenck commented Dec 16, 2024

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

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes Broken link #36040

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Simplified language in the documentation for the APC UPS Daemon integration.
    • Adjusted formatting for the NISIP directive for improved clarity.

@home-assistant home-assistant Bot added the current This PR goes into the current branch label Dec 16, 2024
@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 16, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 5702c9e
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/675fdaa31f2f2d00081a9795
😎 Deploy Preview https://deploy-preview-36378--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 16, 2024

📝 Walkthrough

Walkthrough

The 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

File Change Summary
source/_integrations/apcupsd.markdown - Simplified first paragraph by removing "using the net driver" phrase
- Removed hyperlink formatting for NISIP directive in the note

Assessment against linked issues

Objective Addressed Explanation
Fix broken link [#36040]

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d9e8f7f and 5702c9e.

📒 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

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.

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.

---

[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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

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.

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.

Copy link
Copy Markdown
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @frenck 👍

@c0ffeeca7 c0ffeeca7 merged commit 7e614a4 into current Dec 16, 2024
@c0ffeeca7 c0ffeeca7 deleted the frenck-2024-0644 branch December 16, 2024 13:27
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 17, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

current This PR goes into the current branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken link

2 participants