Update steps on updating to reflect the current software #39267
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for updating Home Assistant Core and Home Assistant Operating System was reorganized and clarified. New section headers, expanded step-by-step instructions, and troubleshooting guidance were added. Backup procedures and post-update checks were emphasized, and an advanced section on OS boot slots was introduced. No code or public API changes occurred. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant UI
participant System
User->>UI: Open update notification
UI->>User: Display update options
User->>UI: (Optional) Enable backup toggle
User->>UI: Initiate update
UI->>System: Perform update
System-->>UI: Update complete
UI->>User: Prompt to check repair issues and logs
sequenceDiagram
participant User
participant UI
participant System
User->>UI: Cannot see update notification
UI->>User: Suggest manual check for updates
User->>UI: Open settings (cogwheel)
UI->>User: Make update notification visible
User->>UI: Proceed with update as above
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.17.2)source/_includes/common-tasks/update.md1-1: First line in a file should be a top-level heading (MD041, first-line-heading, first-line-h1) 🪛 LanguageToolsource/_includes/common-tasks/update.md[grammar] ~27-~27: The word “backup” is a noun. The verb is spelled with a space. (NOUN_VERB_CONFUSION) 🔇 Additional comments (4)
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (4)
source/_includes/common-tasks/update.md (2)
26-29: Duplicate post-update step inside UI tab
Step 7 in the UI tab (“Check for repair issues…”) is duplicated by the universal reminder below. To reduce confusion, remove this inline step and rely on the global notice.Proposed diff:
@@ UI tab content (lines 26-29) - 7. Check if there are any repair issues and check the logs to see if there are any issues with your configuration that need to be addressed.
67-67: Keep universal post-update reminder only
The standalone “After the update, check if there are any repair issues…” notice covers both UI and CLI flows. Recommend deleting the inline UI step and keeping only this global reminder.source/common-tasks/os.markdown (2)
44-47: Use verb form “Back up” for consistency
The imperative should be “Back up your installation” (verb), not the noun “Backup.”Suggested diff:
@@ prerequisites for OS update - - [Backup your installation](/common-tasks/general/#backups). + - [Back up your installation](/common-tasks/general/#backups).🧰 Tools
🪛 LanguageTool
[grammar] ~44-~44: The word ‘Backup’ is a noun. Do you mean the verb “Back up”?
Context: ...ard-compatible. #### Prerequisites - [Backup your installation](/common-tasks/genera...(SENT_START_BACKUP)
[style] ~45-~45: This phrase is redundant. Consider using “outside”.
Context: ...sks/general/#defining-backup-locations) outside of the device where Home Assistant is inst...(OUTSIDE_OF)
79-104: Nitpick: fix pluralization in Advanced section
The sentence reads “if the Operating Systems runs...” – change to singular “Operating System runs.”Example diff:
@@ About boot slots (Advanced section) - Alternatively, if the Operating Systems runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot. + Alternatively, if the Operating System runs on a platform that uses the GRUB bootloader, a boot menu is presented early in the boot.🧰 Tools
🪛 LanguageTool
[typographical] ~83-~83: The conjunction “so that” does not have a comma in front.
Context: ...utomatically uses the previous boot slot, so that it boots from the last working operatin...(SO_THAT_UNNECESSARY_COMMA)
[uncategorized] ~87-~87: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e useful in cases where the system boots but something still seems wrong. For exampl...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~87-~87: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...e device is no longer correctly detected or you see another issue that might be rel...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (2)
source/_includes/common-tasks/update.md(3 hunks)source/common-tasks/os.markdown(4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/common-tasks/os.markdown
[grammar] ~44-~44: The word ‘Backup’ is a noun. Do you mean the verb “Back up”?
Context: ...ard-compatible. #### Prerequisites - [Backup your installation](/common-tasks/genera...
(SENT_START_BACKUP)
[style] ~45-~45: This phrase is redundant. Consider using “outside”.
Context: ...sks/general/#defining-backup-locations) outside of the device where Home Assistant is inst...
(OUTSIDE_OF)
[uncategorized] ~59-~59: Consider adding a hyphen.
Context: ...ee that notification: - In the top right corner, select the three dots {% icon "...
(TOP_LEFT_CORNER)
🪛 markdownlint-cli2 (0.17.2)
source/common-tasks/os.markdown
67-67: Trailing spaces
Expected: 0 or 2; Actual: 3
(MD009, no-trailing-spaces)
source/_includes/common-tasks/update.md
1-1: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)
🔇 Additional comments (4)
source/_includes/common-tasks/update.md (2)
1-6: Clear Prerequisites section added
The new “#### Prerequisites” block clearly outlines backup and release-note checks before updating Core. Links and numbering look correct.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: First line in a file should be a top-level heading
null(MD041, first-line-heading, first-line-h1)
7-7: Added Core update header
Introducing “#### To update Home Assistant Core” improves navigation and mirrors the pattern in OS docs.source/common-tasks/os.markdown (2)
34-37: Add-ons noted as separate update component
Including{% term "Add-ons" %}, if you have any installedand clarifying that each component is updated separately is accurate and in line with Core docs.
58-62: UI troubleshooting instructions align with Core update
The added troubleshooting bullets match the Core update include (common-tasks/update.md) and improve discoverability when notifications don’t appear.🧰 Tools
🪛 LanguageTool
[uncategorized] ~59-~59: Consider adding a hyphen.
Context: ...ee that notification: - In the top right corner, select the three dots {% icon "...(TOP_LEFT_CORNER)
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: Stefan Agner <[email protected]>
Co-authored-by: Stefan Agner <[email protected]>
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit