Skip to content
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

Update references to backup topics #36685

Merged
merged 2 commits into from
Jan 3, 2025
Merged

Update references to backup topics #36685

merged 2 commits into from
Jan 3, 2025

Conversation

c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented Jan 3, 2025

Proposed change

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

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
    • Updated multiple documentation pages to correct links for backup-related tasks.
    • Redirected backup restoration, deletion, and location links from /common-tasks/os/ to /common-tasks/general/.

Sorry, something went wrong.

@c0ffeeca7 c0ffeeca7 requested a review from a team as a code owner January 3, 2025 17:13
@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Jan 3, 2025
@c0ffeeca7 c0ffeeca7 added this to the 2025.1 milestone Jan 3, 2025
Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit be3809d
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67781bc331b77d000812648d
😎 Deploy Preview https://deploy-preview-36685--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.

Copy link
Contributor

coderabbitai bot commented Jan 3, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request involves updating documentation links across multiple files to redirect users from the /common-tasks/os/ directory to the /common-tasks/general/ directory. These changes specifically affect links related to backup and data migration tasks, ensuring that users are directed to the correct documentation sections for restoring backups, deleting obsolete backups, and defining backup locations.

Changes

File Change Summary
source/_includes/common-tasks/data_disk.md Updated backup restoration link from /common-tasks/os/#restoring-a-backup to /common-tasks/general/#restoring-a-backup
source/_integrations/backup.markdown Modified link for restoring a backup to point to the "General" section
source/more-info/free-space.markdown Updated three links to redirect from /common-tasks/os/ to /common-tasks/general/ for:
- Deleting obsolete backups
- Restoring Home Assistant from backup
- Defining backup locations
source/common-tasks/os.markdown Updated backup link from /common-tasks/os/#backups to /common-tasks/general/#backups

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5f5c4d3 and be3809d.

📒 Files selected for processing (1)
  • source/common-tasks/os.markdown (1 hunks)

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
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: 1

🧹 Nitpick comments (1)
source/_includes/common-tasks/data_disk.md (1)

69-69: Add comma for improved readability

Consider adding a comma after "external disk" to improve readability.

-The aim is to migrate the data from system 1 to system 2. One way to do this is by [restoring a backup](/common-tasks/general/#restoring-a-backup). The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk or if your external disk has more storage capacity than your new system.
+The aim is to migrate the data from system 1 to system 2. One way to do this is by [restoring a backup](/common-tasks/general/#restoring-a-backup). The other way is to move the data disk. This can be an interesting option if you have a large amount of data on your external disk, or if your external disk has more storage capacity than your new system.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~69-~69: Possible missing comma found.
Context: ...a large amount of data on your external disk or if your external disk has more stora...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 39480e7 and 5f5c4d3.

📒 Files selected for processing (3)
  • source/_includes/common-tasks/data_disk.md (1 hunks)
  • source/_integrations/backup.markdown (1 hunks)
  • source/more-info/free-space.markdown (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • source/_integrations/backup.markdown
🧰 Additional context used
🪛 LanguageTool
source/_includes/common-tasks/data_disk.md

[uncategorized] ~69-~69: Possible missing comma found.
Context: ...a large amount of data on your external disk or if your external disk has more stora...

(AI_HYDRA_LEO_MISSING_COMMA)

🔇 Additional comments (1)
source/_includes/common-tasks/data_disk.md (1)

69-69: Verify all backup-related URLs are updated

The backup URL update is consistent with changes in other files. However, there's another backup-related link on line 73 that might need to be updated to the new path.

✅ Verification successful

Let me verify if there are any other backup-related URLs in the codebase that need to be updated.


Both backup-related URLs in the file are already updated correctly

Based on the search results, both backup-related URLs in the data_disk.md file have already been updated to use the new /common-tasks/general/# path:

  • Line 69: [restoring a backup](/common-tasks/general/#restoring-a-backup)
  • Line 73: [Create a backup](/common-tasks/general/#backups)

Additionally, the search across the codebase shows that other files have been consistently updated to use the new path, with redirects in place from the old paths (/common-tasks/os/#) to the new ones (/common-tasks/general/#).

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify if all backup-related URLs in this file have been updated
rg "common-tasks/(os|general).*backup" "source/_includes/common-tasks/data_disk.md"

Length of output: 635


Script:

#!/bin/bash
# Search for old backup-related URLs across the codebase
rg "common-tasks/os.*backup" 

# Search for new backup-related URLs across the codebase
rg "common-tasks/general.*backup"

Length of output: 5562

🧰 Tools
🪛 LanguageTool

[uncategorized] ~69-~69: Possible missing comma found.
Context: ...a large amount of data on your external disk or if your external disk has more stora...

(AI_HYDRA_LEO_MISSING_COMMA)

@frenck frenck merged commit 43afc58 into next Jan 3, 2025
9 checks passed
@frenck frenck deleted the backup-links-update branch January 3, 2025 17:20
@frenck frenck added the cherry-picked This PR has been manually picked and merged into the current branch label Jan 3, 2025
frenck pushed a commit that referenced this pull request Jan 3, 2025

Verified

This commit was signed with the committer’s verified signature. The key has expired.
frenck Franck Nijhof
@github-actions github-actions bot locked and limited conversation to collaborators Jan 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cherry-picked This PR has been manually picked and merged into the current branch has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants