Move backup to installation independent section of common tasks #36679
Conversation
home-assistant
bot
added
has-parent
📝 WalkthroughWalkthroughThe changes involve a comprehensive documentation restructuring focused on backup-related links across multiple Home Assistant documentation files. The primary modification is shifting backup documentation references from an operating system-specific context ( Changes
Sequence DiagramsequenceDiagram
participant User
participant Docs
participant BackupSection
User->>Docs: Access backup documentation
Docs->>BackupSection: Redirect to general backup section
BackupSection-->>User: Provide backup instructions
The sequence diagram illustrates the new documentation flow, where users are consistently directed to a centralized, general backup documentation section, regardless of their Home Assistant installation method. 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 (
|
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_includes/common-tasks/update.md (1)
3-3: Use the correct verb form for clarity in step-by-step instructions.
"Backup" is typically used as a noun; in an imperative statement, use “Back up” to avoid confusion.- 1. Backup your installation... + 1. Back up your installation...🧰 Tools
🪛 LanguageTool
[grammar] ~3-~3: The word ‘Backup’ is a noun. Do you mean the verb “Back up”?
Context: ...e for updating Home Assistant Core: 1. Backup your installation{% if page.installatio...(SENT_START_BACKUP)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (13)
source/_docs/configuration.markdown(1 hunks)source/_includes/common-tasks/data_disk.md(1 hunks)source/_includes/common-tasks/specific_version.md(1 hunks)source/_includes/common-tasks/update.md(1 hunks)source/_integrations/backup.markdown(1 hunks)source/_redirects(1 hunks)source/common-tasks/container.markdown(1 hunks)source/common-tasks/core.markdown(1 hunks)source/common-tasks/general.markdown(1 hunks)source/common-tasks/os.markdown(0 hunks)source/common-tasks/supervised.markdown(0 hunks)source/getting-started/configuration.markdown(2 hunks)source/installation/index.html(1 hunks)
💤 Files with no reviewable changes (2)
- source/common-tasks/supervised.markdown
- source/common-tasks/os.markdown
✅ Files skipped from review due to trivial changes (3)
- source/common-tasks/container.markdown
- source/common-tasks/core.markdown
- source/_includes/common-tasks/data_disk.md
🧰 Additional context used
📓 Path-based instructions (1)
source/_redirects (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
🪛 LanguageTool
source/_includes/common-tasks/update.md
[grammar] ~3-~3: The word ‘Backup’ is a noun. Do you mean the verb “Back up”?
Context: ...e for updating Home Assistant Core: 1. Backup your installation{% if page.installatio...
(SENT_START_BACKUP)
🔇 Additional comments (8)
source/_redirects (1)
403-405: Double-check consistency of snapshot vs. backup terminology.
Lines 403, 404, and 405 replace “snapshots” references with “backups.” Confirm that all references to “snapshots” throughout the codebase and documentation remain consistent with these adjustments and do not create user confusion or redirect loops.✅ Verification successful
Based on the search results, I can provide the final response as there is sufficient context to verify the concern about snapshot vs. backup terminology consistency.
Terminology change from "snapshots" to "backups" is consistent with codebase
The redirects in lines 403-405 that change references from "snapshots" to "backups" are consistent with the codebase. The search results show that the term "snapshot" is primarily used in different contexts:
- Test snapshots - Used extensively throughout the codebase for testing purposes
- Camera snapshots - Used specifically for camera/image functionality
- Stream snapshots - Used for video streaming features
The redirects specifically change documentation paths from
/common-tasks/os/#snapshotsand/common-tasks/supervised/#snapshotsto/common-tasks/general/#backups, which appears to be an intentional standardization of backup-related terminology in the documentation. There are no other instances found where "snapshots" is used in the context of system backups that would need to be updated.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any references to "snapshot" that might need updating: rg -A 3 -i 'snapshot'Length of output: 73604
source/_includes/common-tasks/specific_version.md (1)
23-23: Good alignment with the new general backup section.
The link now points to a more general location for backups, which aligns with installation-independent steps.source/common-tasks/general.markdown (1)
8-9: New backup reference included.
Adding{% include common-tasks/backups.md %}provides a centralized place for backup procedures, improving cross-installation guidance.source/getting-started/configuration.markdown (2)
11-11: Link updated to the new backup section.
This updated link is aligned with the generalizing effort for backup documentation.
43-44: Rebranded references to general backup documentation.
These items are consistent with the new universal backup section, ensuring uniform guidance.source/_integrations/backup.markdown (1)
26-26: LGTM! Link update aligns with documentation restructuring.The change correctly updates the reference to the backup documentation, making it installation-method independent.
source/_docs/configuration.markdown (1)
9-9: LGTM! Documentation reference properly updated.The related documentation link has been correctly updated to point to the installation-independent backup section.
source/installation/index.html (1)
335-335: LGTM! Installation comparison table properly updated.The backup feature link in the installation comparison table has been correctly updated to reference the general backup section. The associated footnotes maintain accurate information about backup capabilities across different installation methods.
frenck
added
the
cherry-picked
Proposed change
Move backup to installation independent section of common tasks
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Documentation
Chores