Add documentation for backup folder rename to onedrive #37434
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the OneDrive integration has been updated to clarify the backup folder configuration. The changes add the phrase “by default” to indicate standard behavior and introduce a new "Backup folder" section that details the backup folder path, its unique naming per Home Assistant instance, and its non-configurability due to permission constraints. Additionally, a new configuration option, "Folder name," has been added to describe the instance-specific backup folder during integration setup or reconfiguration. Changes
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 (
|
![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 (2)
source/_integrations/onedrive.markdown (2)
42-42: Fix minor formatting issues.Please address the following formatting issues:
- Remove the comma before "because" as it's essential to the meaning
- Add commas before and after "however"
- Remove trailing space at the end of the line
-The backup folder is `root:\Apps\[Home Assistant | Graph]\backups_{id}`. This is not configurable, because otherwise the integration would need permissions to write in your entire drive. You can however rename the application folder which is called `Home Assistant` or `Graph` in your OneDrive. +The backup folder is `root:\Apps\[Home Assistant | Graph]\backups_{id}`. This is not configurable because otherwise the integration would need permissions to write in your entire drive. You can, however, rename the application folder which is called `Home Assistant` or `Graph` in your OneDrive.🧰 Tools
🪛 LanguageTool
[formatting] ~42-~42: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...\backups_{id}`. This is not configurable, because otherwise the integration would need pe...(COMMA_BEFORE_BECAUSE)
[typographical] ~42-~42: Consider adding two commas here.
Context: ...s to write in your entire drive. You can however rename the application folder which is ...(HOWEVER_COMMA)
🪛 markdownlint-cli2 (0.17.2)
42-42: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
44-44: Consider adding a configuration example.To help users better understand how to use the new folder name feature, consider adding a YAML configuration example showing how to set or change the backup folder name.
# Example configuration.yaml entry onedrive: folder_name: "my_ha_backups" # Optional: Custom name for the backup folder
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/onedrive.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/onedrive.markdown
[formatting] ~42-~42: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...\backups_{id}`. This is not configurable, because otherwise the integration would need pe...
(COMMA_BEFORE_BECAUSE)
[typographical] ~42-~42: Consider adding two commas here.
Context: ...s to write in your entire drive. You can however rename the application folder which is ...
(HOWEVER_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/onedrive.markdown
42-42: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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 (3)
source/_integrations/onedrive.markdown (3)
21-21: LGTM! Good clarification.Adding "by default" helps users understand that this is the standard behavior but can be modified.
35-36: LGTM! Well-documented configuration option.The configuration option is clear and the cross-reference to the backup folder section is helpful for users.
40-44: LGTM! Clear explanation of backup folder behavior.The section effectively explains both the technical constraints and user options for backup folder configuration.
🧰 Tools
🪛 LanguageTool
[formatting] ~42-~42: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...\backups_{id}`. This is not configurable, because otherwise the integration would need pe...(COMMA_BEFORE_BECAUSE)
[typographical] ~42-~42: Consider adding two commas here.
Context: ...s to write in your entire drive. You can however rename the application folder which is ...(HOWEVER_COMMA)
🪛 markdownlint-cli2 (0.17.2)
42-42: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/onedrive.markdown (1)
40-42: Fix trailing space.Remove the trailing space at the end of line 42 to comply with markdown formatting standards.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/onedrive.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/onedrive.markdown
42-42: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
⏰ 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 (4)
source/_integrations/onedrive.markdown (4)
21-21: LGTM!Clear description of the default backup location with proper formatting.
35-36: LGTM!Well-structured configuration option with clear description and helpful cross-reference.
42-42: LGTM!Clear explanation of the backup folder path and its limitations.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
44-44: LGTM!Comprehensive explanation of the instance-specific folder naming and configuration options.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit