Add S3 #37771

tomasbedrich · 2025-03-02T08:17:22Z

Proposed change

Add docs for a new S3 integration.

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).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Add S3 integration core#139325
Link to parent pull request in the Brands repository: Add S3 icons brands#6654
This PR fixes or closes issue: -

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

Documentation
- Added a new markdown file for configuring S3 (and compatible services) as a Home Assistant backup solution.
- The guide includes necessary configuration steps and required parameters such as Access Key ID, Secret Access Key, Bucket Name, and Endpoint URL.
- It also outlines standard removal procedures for a seamless setup experience.

netlify · 2025-03-02T08:17:45Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`bc9b3a9`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/680f76ce48d80800096e3ef9
😎 Deploy Preview	https://deploy-preview-37771--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

coderabbitai · 2025-03-02T08:21:11Z

📝 Walkthrough

Walkthrough

A new markdown file has been introduced to document the S3 integration for Home Assistant backups. This file includes setup instructions, metadata, configuration parameters (Access Key ID, Secret Access Key, Bucket Name, and Endpoint URL), and guidance on removing the integration. It also highlights compatibility with S3-compatible services such as Minio.

Changes

File	Summary of Changes
`source/_integrations/s3.markdown`	Created new documentation for the S3 integration, detailing setup configuration, required parameters, and removal instructions.

📜 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 40e1433 and bc9b3a9.

📒 Files selected for processing (1)

source/_integrations/s3.markdown (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/s3.markdown

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.

❤️ 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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@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.

coderabbitai

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d22a7e2 and f7e952e.

📒 Files selected for processing (1)

source/_integrations/s3.markdown (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: home-assistant.io Test

source/_integrations/s3.markdown

[error] 30-30: Incorrect usage of the term: “docs”, use “documentation” instead terminology

🔇 Additional comments (5)

source/_integrations/s3.markdown (5)

1-13: Metadata Block Verification

The front matter metadata is complete and follows Home Assistant’s documentation standards. All required fields (title, description, ha_release, ha_category, ha_iot_class, ha_config_flow, ha_domain, ha_codeowners, ha_integration_type) are provided and correctly formatted.

15-18: Integration Overview

The introductory text clearly describes the purpose of the integration and mentions that both AWS S3 and S3-compatible services (e.g., Minio) are supported. This provides useful context for users.

20-20: Config Flow Inclusion

The inclusion of the standard Config Flow documentation via the {% include integrations/config_flow.md %} tag is correct and ensures consistency across integrations.

22-31: Configuration Parameters Block

The configuration block is well-organized, with each parameter clearly listed alongside its description. This helps users understand the required setup details for the integration.

🧰 Tools

🪛 GitHub Actions: home-assistant.io Test

[error] 30-30: Incorrect usage of the term: “docs”, use “documentation” instead terminology

33-37: Removal Instructions Clarity

The "Removing the integration" section is concise and correctly indicates that standard removal procedures apply. Including the {% include integrations/remove_device_service.md %} tag provides users with appropriate guidance.

source/_integrations/s3.markdown

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

source/_integrations/s3.markdown

c0ffeeca7

Thank you, @tomasbedrich 👍

Add S3

f7e952e

home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Mar 2, 2025

coderabbitai bot reviewed Mar 2, 2025

View reviewed changes

source/_integrations/s3.markdown Outdated Show resolved Hide resolved

tomasbedrich mentioned this pull request Mar 2, 2025

Add S3 integration home-assistant/core#139325

Merged

19 tasks

Update source/_integrations/s3.markdown

40e1433

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Mar 3, 2025

home-assistant bot added the parent-merged The parent PR has been merged already label Apr 25, 2025

Merge branch 'next' into s3

43ec6c5

c0ffeeca7 reviewed Apr 28, 2025

View reviewed changes

source/_integrations/s3.markdown Outdated Show resolved Hide resolved

source/_integrations/s3.markdown Outdated Show resolved Hide resolved

Apply suggestions from code review

bc9b3a9

c0ffeeca7 approved these changes Apr 28, 2025

View reviewed changes

c0ffeeca7 merged commit 9777a7e into home-assistant:next Apr 28, 2025
7 checks passed

home-assistant bot removed the parent-merged The parent PR has been merged already label Apr 28, 2025

tomasbedrich deleted the s3 branch April 28, 2025 17:03

github-actions bot locked and limited conversation to collaborators Apr 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add S3 #37771

Add S3 #37771

tomasbedrich commented Mar 2, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Mar 2, 2025 •

edited

Loading

coderabbitai bot commented Mar 2, 2025 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

c0ffeeca7 left a comment

Add S3 #37771

Add S3 #37771

Conversation

tomasbedrich commented Mar 2, 2025 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

netlify bot commented Mar 2, 2025 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot commented Mar 2, 2025 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

c0ffeeca7 left a comment

Choose a reason for hiding this comment

tomasbedrich commented Mar 2, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Mar 2, 2025 •

edited

Loading

coderabbitai bot commented Mar 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)