Update onedrive docs #37360
Update onedrive docs #37360
Conversation
✅ 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. The integration’s title has been changed to "Microsoft OneDrive" to reflect a refined naming convention. Additionally, a new section has been added to explain that the application-specific backup folder is referred to as "Graph" due to issues with Microsoft’s APIs and Graph services. All other content, including permissions, instructions for application credentials, and known limitations, remains unchanged. 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)
26-27: Improve Punctuation in Important Note
The note regarding the folder naming issue is very helpful. However, to enhance readability, consider adding a comma after "in that API" so the sentence reads:
"Because of an issue in that API, the application folder is often not named with the name of the application (Home Assistant), butGraphinstead."
This small change will conform better to natural language flow.
65-67: Detailed Explanation for Folder Naming Is Informative
The expanded explanation regarding the Graph API and its effects on folder names is very informative. As noted in the static analysis hint, consider inserting a comma after "in that API" to enhance clarity. Below is a proposed diff:-This integration uses Microsoft's Graph API to communicate with your OneDrive. Because of an [issue](https://github.com/OneDrive/onedrive-api-docs/issues/1866) in that API the application folder is often not named with the name of the application (`Home Assistant`), but `Graph` instead. +This integration uses Microsoft's Graph API to communicate with your OneDrive. Because of an [issue](https://github.com/OneDrive/onedrive-api-docs/issues/1866) in that API, the application folder is often not named with the name of the application (`Home Assistant`), but `Graph` instead.This adjustment will improve grammatical correctness.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: A comma might be missing here.
Context: .../onedrive-api-docs/issues/1866) in that API the application folder is often not nam...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/onedrive.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/onedrive.markdown
[uncategorized] ~66-~66: A comma might be missing here.
Context: .../onedrive-api-docs/issues/1866) in that API the application folder is often not nam...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🔇 Additional comments (3)
source/_integrations/onedrive.markdown (3)
2-2: Title Update Reflects Branding Change
The integration title has been updated to "Microsoft OneDrive" to better reflect the service branding. This change is clear and aligns with the PR objectives.
19-19: Integration Description Update is Clear
The revised introductory sentence now correctly references "Microsoft OneDrive" with a relevant link, improving clarity for users.
64-64: New Section for Folder Naming Clarity Added
The addition of the "## Backup folder is calledGraph" section effectively explains the naming anomaly caused by the Graph API. This extra context will be valuable for users who encounter unexpected folder names in their OneDrive.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/onedrive.markdown (1)
64-68: New Section on Backup Folder Naming via Graph APIThe new section titled "## Backup folder is called
Graph" effectively explains that the integration uses Microsoft's Graph API, addressing why the backup folder might not use the expected application name. This additional detail is valuable for troubleshooting and understanding folder naming behavior.Note: Static analysis tools have flagged trailing spaces on lines 66 and 68. To comply with markdown linting standards, consider removing these trailing spaces. Below is a diff suggestion for cleanup:
-This integration uses Microsoft's Graph API to communicate with your OneDrive. Because of an [issue](https://github.com/OneDrive/onedrive-api-docs/issues/1866) in that API, the application folder is often not named with the name of the application (`Home Assistant`), but `Graph` instead. +This integration uses Microsoft's Graph API to communicate with your OneDrive. Because of an [issue](https://github.com/OneDrive/onedrive-api-docs/issues/1866) in that API, the application folder is often not named with the name of the application (`Home Assistant`), but `Graph` instead.-There is no risk of different applications mixing in that `Graph` folder, if you already have such a `Graph` folder from a different application, the next folders will just be called `Graph 1`, `Graph 2` and so on. +There is no risk of different applications mixing in that `Graph` folder, if you already have such a `Graph` folder from a different application, the next folders will just be called `Graph 1`, `Graph 2` and so on.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
66-66: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
68-68: 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(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/onedrive.markdown
66-66: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
68-68: 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)
2-2: Integration Title Update: Confirming Title ChangeUpdating the integration title to "Microsoft OneDrive" correctly reflects the intended rebranding. This change enhances clarity and consistency with Microsoft’s naming conventions.
19-19: Updated Description: Enhanced ClarityThe description now directly references "Microsoft OneDrive" and clearly links the service to Home Assistant Backups. This improves clarity for users starting with the documentation.
26-26: API Issue Clarification and Folder NamingThis update clarifies that, due to an issue in Microsoft’s APIs, the application-specific folder may be called "Graph" instead of "Home Assistant." This additional context helps set user expectations.
* Update onedrive.markdown * Improve readability of OneDrive integration documentation
* Update onedrive.markdown * Improve readability of OneDrive integration documentation
Proposed change
SSIA
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit