Fix steps. Backups are always encrypted #36677
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the Home Assistant backup documentation in the Changes
Note: No changes were made to exported or public entity declarations in this pull request. 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: 0
🧹 Nitpick comments (3)
source/_includes/common-tasks/backups.md (3)
Line range hint
68-80: Consider minor wording improvementThe instructions are clear and accurate, but there's a small opportunity to improve readability in the first sentence.
-This creates a backup instantly. You can create a manual backup at any time, irrespective of any automatic backups you may have defined. +You can create a manual backup at any time, regardless of any automatic backups you may have defined. The backup is created instantly.
133-134: Fix grammatical error in migration descriptionThere's a grammatical error in the sentence structure.
-During onboarding, to migrate your setup to a new device or a to device on which you performed a factory reset. +During onboarding, to migrate your setup to a new device or to a device on which you performed a factory reset.🧰 Tools
🪛 LanguageTool
[grammar] ~133-~133: A noun might be missing after either ‘a’ or ‘to’ (if ‘to’ is used as a preposition).
Context: ...o migrate your setup to a new device or a to device on which you performed a factory...(A_TO)
Line range hint
178-197: Standardize credential terminologyFor consistency with modern technical writing conventions, consider updating the credential terminology.
-The login password and user name must match +The login password and username must match-enter the password and user name as they were +enter the password and username as they were🧰 Tools
🪛 LanguageTool
[style] ~178-~178: It’s more common nowadays to write this noun as one word.
Context: ...the backup. - The login password and user name must match the ones you used at the tim...(RECOMMENDED_COMPOUNDS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/common-tasks/backups.md(9 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/common-tasks/backups.md
[grammar] ~133-~133: A noun might be missing after either ‘a’ or ‘to’ (if ‘to’ is used as a preposition).
Context: ...o migrate your setup to a new device or a to device on which you performed a factory...
(A_TO)
[style] ~178-~178: It’s more common nowadays to write this noun as one word.
Context: ...the backup. - The login password and user name must match the ones you used at the tim...
(RECOMMENDED_COMPOUNDS)
[style] ~197-~197: It’s more common nowadays to write this noun as one word.
Context: ...he login screen, enter the password and user name as they were at the time the backup was...
(RECOMMENDED_COMPOUNDS)
🔇 Additional comments (4)
source/_includes/common-tasks/backups.md (4)
47-48: Well-structured addition about backup encryption!The added information clearly emphasizes that backups are encrypted and properly directs users to the emergency kit documentation.
56-57: Clear explanation of cloud backup storage limitations!The section effectively communicates the storage limit, encryption requirement, and the need for the emergency kit.
110-112: Clear explanation of cloud backup availability!The section effectively explains the cloud backup storage behavior and access requirements.
Line range hint
1-197: Overall documentation improvements are excellent!The changes successfully achieve the PR's objective of clarifying that backups are always encrypted. The documentation is well-structured, comprehensive, and provides clear guidance for users. The additions about the backup emergency kit and encryption requirements are consistently emphasized throughout the document.
🧰 Tools
🪛 LanguageTool
[style] ~178-~178: It’s more common nowadays to write this noun as one word.
Context: ...the backup. - The login password and user name must match the ones you used at the tim...(RECOMMENDED_COMPOUNDS)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_includes/common-tasks/backups.md (2)
56-56: Consider adding emphasis on backup size limit.The information about encryption and emergency kit is well-placed. Consider making the 5 GB limit more prominent, perhaps in a note or warning block, as it's a critical limitation users should be aware of.
-If you have Home Assistant Cloud, you can store a backup of maximum 5 GB on Home Assistant Cloud. +{% note %} +**Important:** Home Assistant Cloud backup storage is limited to 5 GB maximum. +{% endnote %}
133-133: Fix grammatical error: missing article.Add the missing article "a" in the sentence.
-During onboarding, to migrate your setup to a new device or to device on which you performed a factory reset. +During onboarding, to migrate your setup to a new device or to a device on which you performed a factory reset.🧰 Tools
🪛 LanguageTool
[uncategorized] ~133-~133: Possible missing article found.
Context: ...igrate your setup to a new device or to device on which you performed a factory reset....(AI_HYDRA_LEO_MISSING_A)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/common-tasks/backups.md(9 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/common-tasks/backups.md
[uncategorized] ~133-~133: Possible missing article found.
Context: ...igrate your setup to a new device or to device on which you performed a factory reset....
(AI_HYDRA_LEO_MISSING_A)
🔇 Additional comments (4)
source/_includes/common-tasks/backups.md (4)
47-47: LGTM! Clear emphasis on backup encryption.The addition of encryption information and the emergency kit reference improves user awareness of security measures.
Line range hint
68-80: LGTM! Clear and well-structured manual backup instructions.The instructions are logically ordered and maintain consistency with the encryption message. The addition of the emergency kit reference is well-placed.
110-112: LGTM! Clear prerequisites for cloud backup access.The conditions for accessing cloud backups are clearly stated.
172-178: LGTM! Clear restoration instructions with encryption key requirement.The instructions clearly explain the need for the encryption key from the backup emergency kit. The login credential requirements are well-explained.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit