Backup before update - add step #38703
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 57 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation for setting up automatic backups was updated by adding a new step instructing users to define whether to perform automatic backups before updating. This step clarifies its function as a default setting and provides a warning about potential delays for large installations. As a result, the numbering of subsequent steps was incremented, but their content remained unchanged except for the updated step numbers. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant BackupConfigDoc
User ->> BackupConfigDoc: Read setup steps for automatic backups
BackupConfigDoc -->> User: Instruct to define backup schedule
BackupConfigDoc -->> User: NEW: Instruct to set auto-backup before updates (default, can override)
BackupConfigDoc -->> User: Warn about possible delays for large installations
BackupConfigDoc -->> User: Instruct to define number of backups to keep
BackupConfigDoc -->> User: Instruct to define backup data
BackupConfigDoc -->> User: Instruct to define backup locations
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 (1)
source/_includes/common-tasks/backups.md (1)
46-50: Use correct verb form for “back up” and improve wording
The verb form should be two words (“back up”) rather than “backup,” which is a noun. For example:
- Change “Define if you want to backup automatically before updating.”
- to “Define if you want to back up automatically before updating.”
You might also rephrase for clarity, e.g. “Set whether to create a pre-update backup by default.”🧰 Tools
🪛 LanguageTool
[grammar] ~46-~46: The word “backup” is a noun. The verb is spelled with a space.
Context: ...not available. 5. Define if you want to backup automatically before updating. - Thi...(NOUN_VERB_CONFUSION)
📜 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
[grammar] ~46-~46: The word “backup” is a noun. The verb is spelled with a space.
Context: ...not available. 5. Define if you want to backup automatically before updating. - Thi...
(NOUN_VERB_CONFUSION)
[style] ~56-~56: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 8. [Define the location for backups](#...
(EN_WEAK_ADJECTIVE)
🔇 Additional comments (2)
source/_includes/common-tasks/backups.md (2)
53-53: Step renumbering looks good
This line was renumbered from 6 to 7 to account for the new pre-update backup preference step. No other changes needed.
57-57: Step renumbering looks good
The link step was renumbered from 7 to 8 following the insertion of the new step. Content remains accurate.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_includes/common-tasks/backups.md (1)
46-49: Suggest refining the wording for clarity and consistency
Consider using more direct, imperative language and combining short sentences for readability. For example:-5. Define if you want to back up automatically before updating. - - This sets a default. But you can change this setting each time before updating. +5. Decide whether to perform an automatic backup before updating. + - Sets a default, but you can change this before each update. - - If you have a large installation, backing up might take a while. - - This means that your update might start later than you expected. + - For large installations, backups can take longer and may delay your update start time.
📜 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
[style] ~56-~56: As an alternative to the over-used intensifier ‘quite’, consider replacing this phrase.
Context: ... restore. - Some add-ons may also be quite large. 8. [Define the location for backups](#...
(EN_WEAK_ADJECTIVE)
⏰ 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 (2)
source/_includes/common-tasks/backups.md (2)
53-53: Verify updated step numbering: Step 7
The renumbered step for defining which data to back up (7.) correctly follows the new insertion and maintains the ordered list’s continuity.
57-57: Verify updated step numbering: Step 8
The renumbered link to defining backup locations (8.) accurately reflects the shift caused by the newly inserted backup preference step.
Proposed change
Backup before update - add step
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit