Add docs for Backblaze B2 integration#39169
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 project configuration. |
📝 WalkthroughWalkthroughThe update adds "Backblaze" to the spell checker configuration and introduces a new documentation file detailing the setup and usage of the Backblaze integration for Home Assistant backups. No changes to code logic or public APIs are present. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistantUI
participant BackblazeB2
User->>HomeAssistantUI: Start Backblaze Integration Setup
HomeAssistantUI->>User: Prompt for Key ID, Application Key, Bucket Name, Prefix
User->>HomeAssistantUI: Provide required credentials
HomeAssistantUI->>BackblazeB2: Validate credentials and bucket access
BackblazeB2-->>HomeAssistantUI: Confirm access
HomeAssistantUI->>User: Complete integration setup
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 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)
.vscode/cSpell.json(1 hunks)source/_integrations/backblaze_b2.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/backblaze_b2.markdown
[misspelling] ~39-~39: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...reate an application key" %} To create a application key that can access the buc...
(EN_A_VS_AN)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/backblaze_b2.markdown
[warning] 76-76: Unexpected ordered list item value 1, expected 2 (remark-lint ordered-list-marker-value)
[warning] 77-77: Unexpected ordered list item value 1, expected 3 (remark-lint ordered-list-marker-value)
[warning] 81-81: Unexpected ordered list item value 1, expected 4 (remark-lint ordered-list-marker-value)
⏰ 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 (2)
.vscode/cSpell.json (1)
14-14: Approve addition of 'Backblaze' to spell checker dictionary
Adding "Backblaze" prevents the new integration name from being flagged as a spelling error and aligns with the documentation content.source/_integrations/backblaze_b2.markdown (1)
39-39: Correct indefinite article for grammar
Use “an” before a vowel sound:
[ suggest_nitpick ]
Apply this diff:-To create a application key that can access the bucket: +To create an application key that can access the bucket:🧰 Tools
🪛 LanguageTool
[misspelling] ~39-~39: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...reate an application key" %} To create a application key that can access the buc...(EN_A_VS_AN)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
source/_integrations/backblaze_b2.markdown (1)
7-7: Fixha_iot_classmetadata value
Theha_iot_classfield should use the lowercase snake_case value as defined by Home Assistant’s metadata schema.
Apply this diff:-ha_iot_class: Cloud Push +ha_iot_class: cloud_push
🧹 Nitpick comments (2)
source/_integrations/backblaze_b2.markdown (2)
3-3: Use 'set up' (verb) instead of 'setup'
When used as a verb, "set up" should be two words.
Apply this diff:- description: Instructions on how to setup a Backblaze B2 bucket to be used as a backup location. + description: Instructions on how to set up a Backblaze B2 bucket to be used as a backup location.
39-39: Correct article usage for 'application key'
Use "an" before words starting with a vowel sound.
Apply this diff:- To create a application key that can access the bucket: + To create an application key that can access the bucket:🧰 Tools
🪛 LanguageTool
[misspelling] ~39-~39: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...reate an application key" %} To create a application key that can access the buc...(EN_A_VS_AN)
📜 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 (1)
source/_integrations/backblaze_b2.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/backblaze_b2.markdown
[uncategorized] ~20-~20: You might be missing the article “an” here.
Context: ...tion requires an existing B2 bucket and application key that has access to that bucket. It ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[misspelling] ~39-~39: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...reate an application key" %} To create a application key that can access the buc...
(EN_A_VS_AN)
[uncategorized] ~45-~45: A determiner appears to be missing. Consider inserting it.
Context: ...om the Choose a bucket dropdown. 5. Type of access should be Read and Write....
(AI_EN_LECTOR_MISSING_DETERMINER)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/backblaze_b2.markdown
75-75: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
⏰ 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
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/backblaze_b2.markdown (1)
7-7:⚠️ Potential issueFix
ha_iot_classmetadata value
Theha_iot_classfield must use lowercase snake_case as defined by Home Assistant’s metadata schema.-ha_iot_class: Cloud Push +ha_iot_class: cloud_push
🧹 Nitpick comments (3)
source/_integrations/backblaze_b2.markdown (3)
16-16: Improve phrasing to avoid redundancy
The sentence repeats "use" twice. Reword for clarity and conciseness:-The **Backblaze B2** {% term integration %} allows you to use a [Backblaze B2](https://www.backblaze.com/cloud-storage) bucket for use with Home Assistant Backups. +The **Backblaze B2** {% term integration %} enables you to use a [Backblaze B2](https://www.backblaze.com/cloud-storage) bucket as a backup location in Home Assistant.
20-20: Add missing article for grammatical correctness
Insert "an" before "application key" to fix the missing determiner:-This integration requires an existing B2 bucket and application key that has access to that bucket. +This integration requires an existing B2 bucket and an application key that has access to that bucket.🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: You might be missing the article “an” here.
Context: ...tion requires an existing B2 bucket and application key that has access to that bucket. It ...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
39-39: Fix missing "an" before "application key"
Change "a application key" to "an application key" in the details heading for proper grammar:-To create a application key that can access the bucket: +To create an application key that can access the bucket:🧰 Tools
🪛 LanguageTool
[misspelling] ~39-~39: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...reate an application key" %} To create a application key that can access the buc...(EN_A_VS_AN)
📜 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 (1)
source/_integrations/backblaze_b2.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/backblaze_b2.markdown
[uncategorized] ~20-~20: You might be missing the article “an” here.
Context: ...tion requires an existing B2 bucket and application key that has access to that bucket. It ...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[misspelling] ~39-~39: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...reate an application key" %} To create a application key that can access the buc...
(EN_A_VS_AN)
[uncategorized] ~45-~45: A determiner appears to be missing. Consider inserting it.
Context: ...om the Choose a bucket dropdown. 5. Type of access should be Read and Write....
(AI_EN_LECTOR_MISSING_DETERMINER)
⏰ 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 (1)
source/_integrations/backblaze_b2.markdown (1)
75-82: List numbering now sequential
The ordered list markers correctly increment from 1 to 4, resolving the remark-lint warnings.
| --- | ||
| title: Backblaze B2 | ||
| description: Instructions on how to setup a Backblaze B2 bucket to be used as a backup location. | ||
| ha_release: 2025.6 |
There was a problem hiding this comment.
Not sure if this should be the target release date
There was a problem hiding this comment.
Updated it to 2025.7
There was a problem hiding this comment.
yes, that's correct. It's the release when the integration is merged into Core. so it might still change, depending on when it's merged. 😄
There was a problem hiding this comment.
It's now updated to 2025.10
hugo-vrijswijk
changed the title
c0ffeeca7
added
the
new-integration
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
hugo-vrijswijk
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for the new Backblaze B2 integration, which enables users to configure Backblaze B2 cloud storage as a backup location for Home Assistant. The documentation provides complete setup instructions, security recommendations, and troubleshooting guidance.
Key changes:
- Creates detailed integration documentation with prerequisites, configuration steps, and troubleshooting sections
- Adds "Backblaze" to the spell checker dictionary to prevent false positives
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| source/_integrations/backblaze_b2.markdown | Complete integration documentation including setup instructions, configuration parameters, and troubleshooting guidance |
| .vscode/cSpell.json | Adds "Backblaze" to spell checker dictionary |
c0ffeeca7
left a comment
c0ffeeca7
left a comment
There was a problem hiding this comment.
Thank you, @hugo-vrijswijk 👍
Proposed change
Add docs for new Backblaze B2 integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
fixes #Checklist
currentbranch.nextbranch.Summary by CodeRabbit