Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Remove links to common tasks for Core and Supervisor #39238

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 26, 2025
Merged

Remove links to common tasks for Core and Supervisor #39238

merged 1 commit into from
May 26, 2025

Conversation

c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented May 26, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Remove links to common tasks for Core and Supervisor
As per architecture discussion on

home-assistant/architecture#1197,
and home-assistant/architecture#1198

https://www.home-assistant.io/blog/2025/05/22/deprecating-core-and-supervised-installation-methods-and-32-bit-systems

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 #

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 configuration check instructions by removing references to "Core" and "Supervised" installation types across relevant documentation and FAQ sections. Only "Operating System" and "Container" options are now provided for configuration validation and troubleshooting guidance.

@home-assistant home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels May 26, 2025
@netlify Netlify
Copy link

netlify bot commented May 26, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit acfeaff
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/683456a34e90370008860b17
😎 Deploy Preview https://deploy-preview-39238--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 project configuration.

@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 26, 2025

📝 Walkthrough

Walkthrough

The changes update documentation by removing references to configuration check options for "Core" and "Supervised" installation types. Only "Operating System" and "Container" options remain in the lists for configuration validation and troubleshooting. No structural or control flow changes are introduced; the updates are limited to documentation content.

Changes

Files Change Summary
source/_docs/configuration/splitting_configuration.markdown Removed "Core" and "Supervised" configuration check links from the debugging section.
source/_docs/configuration/troubleshooting.markdown Deleted "Core" and "Supervised" configuration check links from the troubleshooting instructions.
source/_faq/component.markdown Eliminated "Core" and "Supervised" configuration check links from the FAQ, leaving two options.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

coderabbitai[bot]
coderabbitai bot reviewed May 26, 2025
View reviewed changes
Copy link
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: 0

🧹 Nitpick comments (1)
source/_faq/component.markdown (1)

12-12: Add a single trailing newline to satisfy Markdown linting
The file currently misses a final newline, triggering MD047 (single-trailing-newline). Please ensure there’s exactly one newline at the end.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

12-12: Files should end with a single newline character
null

(MD047, single-trailing-newline)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 2d2da41 and acfeaff.

📒 Files selected for processing (3)
  • source/_docs/configuration/splitting_configuration.markdown (0 hunks)
  • source/_docs/configuration/troubleshooting.markdown (0 hunks)
  • source/_faq/component.markdown (1 hunks)
💤 Files with no reviewable changes (2)
  • source/_docs/configuration/splitting_configuration.markdown
  • source/_docs/configuration/troubleshooting.markdown
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_faq/component.markdown

12-12: Files should end with a single newline character
null

(MD047, single-trailing-newline)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_faq/component.markdown (1)

11-12:

✅ Verification successful

Removed deprecated installation type links – aligns with deprecation roadmap
The removal of “Core” and “Supervised” links narrows the guidance to the supported installation types (Operating System and Container), which matches the deprecation plan discussed in home-assistant/architecture#1197 and #1198. Please verify that no other documentation still references the old Core or Supervised common-tasks sections.

Run this script to confirm there are no lingering references in the repo:

🏁 Script executed:

#!/bin/bash
# Verify no residual Core or Supervised CLI links to common-tasks
rg -n 'common-tasks/(core|supervised)' -g '*.md' .

Length of output: 52

Let’s expand the search to include both .md and .markdown files:

🏁 Script executed:

#!/bin/bash
# Re-verify no residual “core” or “supervised” common-tasks links in all markdown files
rg -n 'common-tasks/(core|supervised)' -g '*.md' -g '*.markdown' .

Length of output: 68

No lingering Core or Supervised references found – ready to approve
We’ve searched all .md and .markdown files with:

rg -n 'common-tasks/(core|supervised)' -g '*.md' -g '*.markdown' .

and confirmed there are no matches. Removing these deprecated links is safe and aligns with the deprecation roadmap.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

12-12: Files should end with a single newline character
null

(MD047, single-trailing-newline)

@c0ffeeca7 c0ffeeca7 merged commit 09a32d3 into current May 26, 2025
9 checks passed
@home-assistant home-assistant bot removed the in-progress This PR/Issue is currently being worked on label May 26, 2025
@c0ffeeca7 c0ffeeca7 deleted the remove-links-to-core-supervised-common-tasks branch May 26, 2025 12:02
@home-assistant home-assistant bot removed the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label May 26, 2025
@github-actions github-actions bot locked and limited conversation to collaborators May 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@frenck frenck frenck approved these changes

Assignees

@c0ffeeca7 c0ffeeca7

Labels
current This PR goes into the current branch has-parent This PR has a parent PR in a other repo
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@c0ffeeca7 @frenck