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

Backups #36651

Merged
merged 6 commits into from
Jan 2, 2025
Merged

Backups #36651

merged 6 commits into from
Jan 2, 2025

Conversation

c0ffeeca7
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 commented Jan 2, 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 others were 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
    • Enhanced backup documentation with clearer guidance on the backup process.
    • Expanded instructions for both manual and automatic backup configurations, including scheduling and retention policies.
    • Updated network storage documentation to clarify backup usage for both automatic and manual backups.
    • Restructured instructions for changing the default backup location and added troubleshooting notes for network storage settings.

@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 2, 2025
Copy link

netlify bot commented Jan 2, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit c49a31b
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6776a2f92d89f40008ea66ec
😎 Deploy Preview https://deploy-preview-36651--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 2, 2025

Warning

Rate limit exceeded

@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 0 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 5e3f772 and c49a31b.

📒 Files selected for processing (2)
  • source/_includes/common-tasks/backups.md (3 hunks)
  • source/_includes/common-tasks/network_storage.md (1 hunks)
📝 Walkthrough

Walkthrough

The pull request involves updates to two documentation files related to backup and network storage in Home Assistant. The changes focus on improving the clarity, comprehensiveness, and structure of the documentation. The backup documentation has been expanded to provide more detailed guidance on backup processes, including preparation steps, automatic backup configuration, and backup location management. The network storage documentation has been refined to better explain backup usage types, default backup location selection, and added troubleshooting information.

Changes

File Change Summary
source/_includes/common-tasks/backups.md - Enhanced introduction emphasizing backup importance
- Added steps for checking disk space
- Detailed instructions for automatic backup configuration
- Clarified backup location definition
- Added new subsection on downloading local backups
source/_includes/common-tasks/network_storage.md - Refined description of "Backup" usage type
- Restructured default backup location instructions
- Added troubleshooting note for external storage
- Improved formatting and added illustrative image

Sequence Diagram

sequenceDiagram
    participant User
    participant HA as Home Assistant
    participant Storage as Backup Storage

    User->>HA: Configure Backup Settings
    HA->>Storage: Set Backup Location
    HA->>Storage: Configure Backup Schedule
    HA->>Storage: Define Retention Policy
    Storage-->>HA: Backup Created
    User->>HA: Download/Manage Backups
Loading

This sequence diagram illustrates the high-level process of configuring and managing backups in Home Assistant, showing the interactions between the user, Home Assistant, and backup storage.


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

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

74-74: Improve clarity of backup usage type description

The description should clarify that this becomes the default target for the first storage added. Consider rewording for better clarity.

-  description: This will become a target. You can use it when creating an automatic or manual backup. The first storage you add of this type becomes your new default target. If you want to change the default target, [check out the documentation below](#change-default-backup-location).
+  description: "This storage will be available as a backup target for both automatic and manual backups. The first storage you add of this type automatically becomes your default backup target. You can change this later (see [Change default backup location](#change-default-backup-location))."
source/_includes/common-tasks/backups.md (3)

3-5: Grammar improvements needed

The text needs some grammatical refinements for better clarity.

-It is important to regularly back up your Home Assistant setup. You may have spent many hours configuring your system and creating automations. Keep your configurations safe so that you can [restore](#restoring-a-backup) a system or parts of it if a rollback is needed or to migrate your Home Assistant to new hardware.
+It is important to regularly back up your Home Assistant setup. You may have spent many hours configuring your system and creating automations. Keep your configurations safe so you can [restore](#restoring-a-backup) your system (or parts of it) if a rollback is needed or when migrating Home Assistant to new hardware.

-Backups are encrypted and stored in a compressed archive file (.tar) and by default, stored locally in the `/backup` directory.
+Backups are encrypted and stored in a compressed archive file (.tar) and, by default, stored locally in the `/backup` directory.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~5-~5: Possible missing comma found.
Context: ...red in a compressed archive file (.tar) and by default, stored locally in the `/bac...

(AI_HYDRA_LEO_MISSING_COMMA)


31-49: Comprehensive automatic backup setup instructions

The automatic backup setup instructions are clear and include important considerations about retention and data selection. However, there's a grammatical issue with "backup" usage.

-6. Define the data you want to backup.
+6. Define the data you want to back up.
🧰 Tools
🪛 LanguageTool

[grammar] ~42-~42: The word “backup” is a noun. The verb is spelled with a space.
Context: ...deleted. 6. Define the data you want to backup. - It is recommended to disable medi...

(NOUN_VERB_CONFUSION)


[style] ~45-~45: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 7. [Define the location for backups](#...

(EN_WEAK_ADJECTIVE)

🪛 Markdownlint (0.37.0)

46-46: null
Link fragments should be valid

(MD051, link-fragments)


66-79: Manual backup instructions need grammatical fixes

The manual backup instructions are clear but contain the same grammatical issue with "backup" usage.

-3. Define the data you want to backup.
+3. Define the data you want to back up.
🧰 Tools
🪛 LanguageTool

[grammar] ~72-~72: The word “backup” is a noun. The verb is spelled with a space.
Context: ...ackup**. 3. Define the data you want to backup. - It is recommended to disable medi...

(NOUN_VERB_CONFUSION)


[style] ~75-~75: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 4. Provide a name for the backup. 5. C...

(EN_WEAK_ADJECTIVE)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eae785c and 76c3f95.

⛔ Files ignored due to path filters (4)
  • source/images/screenshots/network-storage/backup_locations_all.png is excluded by !**/*.png
  • source/images/screenshots/network-storage/backup_select_local_default.png is excluded by !**/*.png
  • source/images/screenshots/network-storage/change_backup_dark.png is excluded by !**/*.png
  • source/images/screenshots/network-storage/change_backup_light.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • source/_includes/common-tasks/backups.md (3 hunks)
  • source/_includes/common-tasks/network_storage.md (2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/common-tasks/backups.md

[uncategorized] ~5-~5: Possible missing comma found.
Context: ...red in a compressed archive file (.tar) and by default, stored locally in the `/bac...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~19-~19: Possible missing comma found.
Context: ...migrate the system to new hardware, for example from a Raspberry Pi Compute Module&nbsp...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~42-~42: The word “backup” is a noun. The verb is spelled with a space.
Context: ...deleted. 6. Define the data you want to backup. - It is recommended to disable medi...

(NOUN_VERB_CONFUSION)


[style] ~45-~45: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 7. [Define the location for backups](#...

(EN_WEAK_ADJECTIVE)


[uncategorized] ~52-~52: Possible missing comma found.
Context: ...s recommended to keep a copy on another system and ideally also one off-site. #### Ab...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~72-~72: The word “backup” is a noun. The verb is spelled with a space.
Context: ...ackup**. 3. Define the data you want to backup. - It is recommended to disable medi...

(NOUN_VERB_CONFUSION)


[style] ~75-~75: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 4. Provide a name for the backup. 5. C...

(EN_WEAK_ADJECTIVE)

🪛 Markdownlint (0.37.0)
source/_includes/common-tasks/backups.md

46-46: null
Link fragments should be valid

(MD051, link-fragments)

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

83-91: Well-structured default backup location instructions

The instructions are clear, concise, and include helpful troubleshooting information. The addition of the screenshot enhances user understanding.

source/_includes/common-tasks/backups.md (3)

19-30: Excellent preparation guidance

The preparation steps are well-structured and provide valuable guidance for users, especially the addition of database size checking and disk space verification.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~19-~19: Possible missing comma found.
Context: ...migrate the system to new hardware, for example from a Raspberry Pi Compute Module&nbsp...

(AI_HYDRA_LEO_MISSING_COMMA)


50-64: Clear backup location documentation with helpful visual aid

The backup location section effectively explains the options and includes a helpful screenshot. The Home Assistant Cloud storage limit is clearly stated.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~52-~52: Possible missing comma found.
Context: ...s recommended to keep a copy on another system and ideally also one off-site. #### Ab...

(AI_HYDRA_LEO_MISSING_COMMA)


89-105: Well-organized download instructions

The download instructions are comprehensive and provide multiple options with clear steps. The inclusion of file access configuration reference is particularly helpful.

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

🧹 Nitpick comments (3)
source/_includes/common-tasks/backups.md (3)

Line range hint 3-18: Consider adding backup size considerations in the introduction

The introduction effectively explains the importance of backups and their contents. Consider adding a note about typical backup sizes or factors that affect backup size (like media files and database size) early in this section, as this information becomes crucial later in the preparation steps.

🧰 Tools
🪛 Markdownlint (0.37.0)

1-1: null
First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)


Line range hint 80-88: Consider enhancing CLI documentation

The CLI section could be more helpful with additional examples and common use cases, such as:

  • Creating partial backups
  • Specifying backup names with timestamps
  • Using backup password protection

Would you like me to provide detailed examples for these scenarios?

🧰 Tools
🪛 Markdownlint (0.37.0)

46-46: null
Link fragments should be valid

(MD051, link-fragments)


89-105: Consider adding security recommendations for backup storage

While the download instructions are clear, consider adding security recommendations for storing downloaded backups, such as:

  • Encrypting external storage devices
  • Secure handling of backup files
  • Regular verification of downloaded backups
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 76c3f95 and 5e3f772.

📒 Files selected for processing (1)
  • source/_includes/common-tasks/backups.md (3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_includes/common-tasks/backups.md

46-46: null
Link fragments should be valid

(MD051, link-fragments)

🔇 Additional comments (2)
source/_includes/common-tasks/backups.md (2)

50-65: Well-structured backup locations section

The section effectively explains different backup location options, including cloud storage limitations and network storage setup. The screenshot addition enhances the user experience.


Line range hint 106-200: Excellent restoration and migration documentation

The restoration section is comprehensive and well-structured, with clear prerequisites and detailed migration steps. The inclusion of estimated duration and storage capacity requirements is particularly helpful.

source/_includes/common-tasks/backups.md Outdated Show resolved Hide resolved
source/_includes/common-tasks/backups.md Outdated Show resolved Hide resolved
source/_includes/common-tasks/backups.md Show resolved Hide resolved
c0ffeeca7 and others added 3 commits January 2, 2025 15:25
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @c0ffeeca7 👍

../Frenck

@frenck frenck added this to the 2025.1 milestone Jan 2, 2025
@frenck frenck merged commit 3d6feb2 into next Jan 2, 2025
9 checks passed
@frenck frenck deleted the backups branch January 2, 2025 15:22
@github-actions github-actions bot locked and limited conversation to collaborators Jan 3, 2025
@frenck frenck added the cherry-picked This PR has been manually picked and merged into the current branch label Jan 3, 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.

2 participants