Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add onedrive option flow docs #37583

Merged
merged 2 commits into from
Feb 20, 2025
Merged

Conversation

zweckj
Copy link
Member

@zweckj zweckj commented Feb 20, 2025

Proposed change

SSIA

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Introduced an option to permanently delete files during backups, allowing users to bypass the Recycle Bin.
  • Documentation
    • Updated OneDrive integration documentation with configuration guidance for the new permanent deletion option.

@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Feb 20, 2025
Copy link

netlify bot commented Feb 20, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 7d282d6
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67b6ef5a6447ad0008d1720d
😎 Deploy Preview https://deploy-preview-37583--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Feb 20, 2025
@zweckj zweckj marked this pull request as ready for review February 20, 2025 07:38
Copy link
Contributor

coderabbitai bot commented Feb 20, 2025

📝 Walkthrough

Walkthrough

The changes update the OneDrive integration documentation by adding a new configuration option that allows users to permanently delete files, bypassing the Recycle Bin during backup cleanup. The relevant section in the main documentation file has been updated with this option, and a new file (option_flow.md) has been introduced to provide additional details on configuring these options.

Changes

File(s) Changed Summary
source/_integrations/onedrive.markdown, option_flow.md Updated documentation for OneDrive integration to include a new "Delete files permanently" configuration option and added supporting details in a new options file.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant BS as Backup System
    participant OD as OneDrive API
    U->>BS: Initiate backup cleanup
    BS->>BS: Check deletion configuration
    alt Permanent deletion enabled
        BS->>OD: Delete file permanently (bypass Recycle Bin)
        OD-->>BS: Confirmation of deletion
    else Standard deletion
        BS->>OD: Delete file (move to Recycle Bin)
        OD-->>BS: Confirmation of deletion
    end
    BS-->>U: Report deletion status
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 79f129c and 7d282d6.

📒 Files selected for processing (1)
  • source/_integrations/onedrive.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/onedrive.markdown
⏰ 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

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/onedrive.markdown (1)

40-43: Improve Configuration Description Punctuation.
The added configuration block for "Delete files permanently:" contains minor punctuation issues (a double period at the end of the description and a potential missing comma). Consider revising the text for clarity and consistency with the documentation standards. For example, you might want to remove the extra period and adjust punctuation as needed.

[typographical]
The following diff illustrates a possible revision:

-  description: By default files are put into the Recycle Bin when they are deleted, where they are available for another 30 days. If you enable this option, files will be deleted immediately when they are cleaned up by the backup system..
+  description: By default, files are put into the Recycle Bin when deleted, where they remain available for another 30 days. If you enable this option, files will be deleted immediately when they are cleaned up by the backup system.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~42-~42: Possible missing comma found.
Context: ...te files permanently: description: By default files are put into the Recycle Bin when...

(AI_HYDRA_LEO_MISSING_COMMA)


[typographical] ~42-~42: Two consecutive dots
Context: ...they are cleaned up by the backup system.. {% endconfiguration_basic %} ## Reques...

(DOUBLE_PUNCTUATION)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4c33a1b and 79f129c.

📒 Files selected for processing (1)
  • source/_integrations/onedrive.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/onedrive.markdown

[uncategorized] ~42-~42: Possible missing comma found.
Context: ...te files permanently: description: By default files are put into the Recycle Bin when...

(AI_HYDRA_LEO_MISSING_COMMA)


[typographical] ~42-~42: Two consecutive dots
Context: ...they are cleaned up by the backup system.. {% endconfiguration_basic %} ## Reques...

(DOUBLE_PUNCTUATION)

🔇 Additional comments (1)
source/_integrations/onedrive.markdown (1)

38-38: New Option Flow Inclusion.
The documentation now includes {% include integrations/option_flow.md %}, which introduces the new option flow details. Please verify that the referenced file exists and that its content matches the intended configuration for OneDrive.

@zweckj zweckj added the awaits-parent Awaits the merge of an parent PR label Feb 20, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Feb 20, 2025
@zweckj zweckj merged commit 7705548 into home-assistant:next Feb 20, 2025
7 checks passed
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already awaits-parent Awaits the merge of an parent PR labels Feb 20, 2025
@zweckj zweckj deleted the onedrive/soft-delete branch February 20, 2025 12:36
@github-actions github-actions bot locked and limited conversation to collaborators Feb 21, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants