Skip to content

Update blobstore and communty docs#906

Open
achrinza wants to merge 2 commits into
cloudfoundry:masterfrom
achrinzafork:update-docs-20260622
Open

Update blobstore and communty docs#906
achrinza wants to merge 2 commits into
cloudfoundry:masterfrom
achrinzafork:update-docs-20260622

Conversation

@achrinza

Copy link
Copy Markdown
Contributor

This PR is two changes, one commit each:

  1. Blobstore docs: Removed inaccurate info and note the potential blobstore config footgun.
  2. Community docs: Updated stale information (to the best of my knowledge).

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@achrinza, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 52 minutes and 52 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: df08d42d-4967-40d2-b9fa-50a019b1b546

📥 Commits

Reviewing files that changed from the base of the PR and between 7c42efb and c28449d.

📒 Files selected for processing (5)
  • content/community.md
  • content/create-release.md
  • content/package-vendoring.md
  • content/release-blobstore.md
  • mkdocs.yml

Walkthrough

The pull request updates several BOSH documentation files. content/community.md revises community resource sections: the Slack section gains an invite admonition, the GitHub section drops cloudfoundry-incubator in favor of cloudfoundry, the Roadmap section replaces Pivotal Tracker with GitHub Projects, and the Ultimate Guide to BOSH link changes to a Web Archive URL. content/package-vendoring.md updates the vendor-package guidance to reference packages from the cloudfoundry org. content/release-blobstore.md narrows scope to CLI v2+ release publishing, removes the Azure provider and its configuration section, and adds a warning documenting CLI v2's shallow-merge behavior between config/private.yml and config/final.yml. content/create-release.md removes blobstore_secret from the example and adds a corresponding CLI v2 merge warning. mkdocs.yml adds an Azure Storage Account navigation entry under Configuring the Blobstore.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title directly relates to the main changes in the PR: updates to blobstore documentation and community documentation, though it contains a minor typo ('communty' instead of 'community').
Description check ✅ Passed The description accurately summarizes the two main changes in the PR: blobstore documentation updates and community documentation updates, with sufficient detail about what was changed.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@content/create-release.md`:
- Around line 690-695: In the warning block titled "Managing split-configuration
between `private.yml` and `final.yml`", fix the subject-verb agreement error in
the sentence beginning with "the value of `/blobstore/<provider>/`". Change
"take precedence over" to "takes precedence over" so that the plural verb agrees
with the singular subject "value". This same grammar fix should also be applied
to the duplicate warning text in `release-blobstore.md` to maintain consistency
across both files.

In `@content/release-blobstore.md`:
- Around line 13-20: The warning block in the release-blobstore.md file contains
a subject-verb agreement error. The phrase "the value of
`/blobstore/<provider>/` in `private.yml` is shallow-merged with, and take
precedence over" uses the plural verb "take" with the singular subject "value".
Change "take" to "takes" to ensure proper grammatical agreement between the
subject and both verbs in the compound predicate.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3d72e0cc-17f3-4ca7-af82-b3ab934beae5

📥 Commits

Reviewing files that changed from the base of the PR and between ac13a4b and 7c42efb.

📒 Files selected for processing (5)
  • content/community.md
  • content/create-release.md
  • content/package-vendoring.md
  • content/release-blobstore.md
  • mkdocs.yml

Comment thread content/create-release.md
Comment thread content/release-blobstore.md
achrinza added 2 commits June 22, 2026 23:59
- Add note to differentiate release- and director blobstore.
  There's a cross reference from the Director Blobstore docs to the
  Release Blobstore docs, but not the other way around.

- Warn on the potential publishing of blobstore secrets.
  CLI v2 does not force users to put sensitive blobstore options
  (e.g. `secret_access_key`) in private.yml. Hence, we should document
  how CLI v2 actually uses `private.yml` and `final.yml`, and the
  potential footgun.

- Remove incorrect docs on Azure support for Release Blobstore.
  Although the BOSH Director + BOSH Agent supports Azure blobstore,
  CLIv2 [doesn't share blobstore support
  parity](https://github.com/cloudfoundry/bosh-cli/blob/27b76482223696f45c8269d233a3cdd42cdb77a3/releasedir/provider.go#L114-L125

Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
- Point roadmap from defunct Pivotal Tracker to GitHub Project
- Remove references to no-longer-used `cloudfoundry-incubator` and
  `bosh-packages` GitHub organisations
- Revive with an archive link for now-defunct "Ultimate Guide to BOSH"

Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
@achrinza achrinza force-pushed the update-docs-20260622 branch from 7c42efb to c28449d Compare June 22, 2026 16:00
@github-project-automation github-project-automation Bot moved this from Inbox to Pending Merge | Prioritized in Foundational Infrastructure Working Group Jun 22, 2026
@rkoster rkoster requested review from a team, Alphasite and ystros and removed request for a team June 25, 2026 14:55
@rkoster rkoster moved this from Pending Merge | Prioritized to Pending Review | Discussion in Foundational Infrastructure Working Group Jun 25, 2026
@github-project-automation github-project-automation Bot moved this from Pending Review | Discussion to Pending Merge | Prioritized in Foundational Infrastructure Working Group Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Pending Merge | Prioritized

Development

Successfully merging this pull request may close these issues.

3 participants