Restore from backup during onboarding - update steps #38695
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe backup restoration instructions during onboarding were restructured to clearly delineate two restoration options: restoring from a local backup file or from a Home Assistant Cloud backup. The steps for each option are now explicitly outlined, with updated UI labels and a clarified sequence of actions. Minor adjustments were made to the wording and step order, and the instruction to periodically reload the page during restore was removed and replaced with a warning not to refresh the page. No changes were made to exported or public code entities. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Onboarding UI
participant Local Device
participant Home Assistant Cloud
User->>Onboarding UI: Open Welcome Screen
alt Restore from Local Backup
User->>Onboarding UI: Select "Upload backup"
User->>Onboarding UI: Select "Select backup file"
Onboarding UI->>Local Device: Open file explorer
User->>Local Device: Choose backup file
Local Device->>Onboarding UI: Provide backup file
else Restore from Home Assistant Cloud
User->>Onboarding UI: Select "Home Assistant Cloud"
Onboarding UI->>Home Assistant Cloud: Prompt sign in
User->>Home Assistant Cloud: Sign in
Home Assistant Cloud->>Onboarding UI: Provide backup options
end
User->>Onboarding UI: Select parts to restore, enter encryption key
User->>Onboarding UI: Select "Restore backup"
Onboarding UI->>User: Show restore progress and completion
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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. 🪧 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 (2)
source/_includes/common-tasks/backups.md (2)
193-202: Improve consistency and clarity of options labeling
The phrasing of Option 2 (“restore from a Home Assistant Cloud:”) doesn’t mirror Option 1 (“restore from a local backup:”). Consider dropping the extra article and explicitly calling out the backup source.Proposed diff:
- - **Option 2**: restore from a Home Assistant Cloud: + - **Option 2**: restore from Home Assistant Cloud backup:
203-203: Add missing article for grammatical correctness
The step reads “select all parts you want to restore.” For clarity and consistency, insert “the” before “parts.”Proposed diff:
-3. In the dialog, select all parts you want to restore. +3. In the dialog, select all the parts you want to restore.🧰 Tools
🪛 LanguageTool
[uncategorized] ~203-~203: You might be missing the article “the” here.
Context: ...ant Cloud. 3. In the dialog, select all parts you want to restore. - Your curre...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/common-tasks/backups.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/common-tasks/backups.md
[uncategorized] ~203-~203: You might be missing the article “the” here.
Context: ...ant Cloud. 3. In the dialog, select all parts you want to restore. - Your curre...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_includes/common-tasks/backups.md (1)
193-202: Clarify backup restoration option phrasing and proper noun usageThe bullets under step 2 mix articles and omit “file” for local backups, and use an unnecessary “a” before the service name. For clarity and consistency, consider:
- - **Option 1**: restoring from a local backup. + - **Option 1**: restoring from a local backup file. - - **Option 2**: restoring from a Home Assistant Cloud. + - **Option 2**: restoring from Home Assistant Cloud.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_includes/common-tasks/backups.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_includes/common-tasks/backups.md
[uncategorized] ~203-~203: You might be missing the article “the” here.
Context: ...ant Cloud. 3. In the dialog, select all parts you want to restore. - Your curre...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ 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/_includes/common-tasks/backups.md (1)
207-207: Verify UI label for restore actionThe instruction now reads “select Restore backup”. Please confirm that the onboarding UI’s button text matches this label. If it’s still “Restore”, update the docs; if it’s “Restore backup”, this matches.
|
Thanks! |
Proposed change
Restore from backup during onboarding - update steps
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit