Skip to content

Fix minor typo in object-storage-properties.adoc#1087

Merged
micheleRP merged 1 commit into
mainfrom
JFlath-patch-1
May 6, 2025
Merged

Fix minor typo in object-storage-properties.adoc#1087
micheleRP merged 1 commit into
mainfrom
JFlath-patch-1

Conversation

@JFlath
Copy link
Copy Markdown
Contributor

@JFlath JFlath commented Apr 24, 2025

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Summary by CodeRabbit

  • Documentation
    • Corrected the list of accepted values for the cloud_storage_credentials_source property to clearly list sts and gcp_instance_metadata as separate options.

@JFlath JFlath requested a review from a team as a code owner April 24, 2025 19:16
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 24, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The documentation for the cloud_storage_credentials_source property was updated to fix a formatting issue in the list of accepted values. Previously, the values sts and gcp_instance_metadata were incorrectly concatenated. The update separates them into two distinct accepted values, ensuring clarity and accuracy in the documentation. No code or public API changes were made.

Changes

File(s) Change Summary
modules/reference/pages/properties/object-storage-properties.adoc Corrected the formatting of the accepted values for cloud_storage_credentials_source, separating sts and gcp_instance_metadata into individual options.

Poem

In the docs a fix was made,
Where values once did masquerade—
Now sts and its friend
Stand alone in the end,
Clear as a carrot in morning shade! 🥕


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.

Support

Need 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)

  • @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 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.

@JFlath JFlath requested a review from Feediver1 April 24, 2025 19:16
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 24, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit a3b5ba0
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/681a39802791c3000820e593
😎 Deploy Preview https://deploy-preview-1087--redpanda-docs-preview.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.

Copy link
Copy Markdown
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)
modules/reference/pages/properties/object-storage-properties.adoc (1)

539-543: Ensure consistency in accepted values formatting
The *Accepted values* line for cloud_storage_credentials_source currently uses inline backticks without square brackets and lists the Azure entries in reverse order compared to cloud_storage_credentials_host. To align with surrounding properties, please:

  • Use the square-bracket notation for value lists.
  • Order Azure entries as azure_aks_oidc_federation before azure_vm_instance_metadata.

Apply this diff:

- *Accepted values*: `config_file`, `aws_instance_metadata`, `sts`, `gcp_instance_metadata`, `azure_vm_instance_metadata`, `azure_aks_oidc_federation`
+ *Accepted values:* [`config_file`, `aws_instance_metadata`, `sts`, `gcp_instance_metadata`, `azure_aks_oidc_federation`, `azure_vm_instance_metadata`]
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6bafa1a and 033ec66.

📒 Files selected for processing (1)
  • modules/reference/pages/properties/object-storage-properties.adoc (1 hunks)

@JFlath
Copy link
Copy Markdown
Contributor Author

JFlath commented Apr 24, 2025

@Feediver1 If you can point me to how to do backports, happy to do the legwork to sort them too :)

@micheleRP
Copy link
Copy Markdown
Contributor

@Feediver1 If you can point me to how to do backports, happy to do the legwork to sort them too :)

Thanks @JFlath! I think this slipped through the cracks, but I'll merge it now. For backporting, you can either make the change in the v/24.3, v/24.2, and v/24.1 branches, or you can file a doc issue for us to do it. (We still show v23.3, but it should come down soon.)

@micheleRP micheleRP merged commit a320e86 into main May 6, 2025
8 checks passed
@micheleRP micheleRP deleted the JFlath-patch-1 branch May 6, 2025 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants