Skip to content

Conversation

micheleRP
Copy link
Contributor

Description

This pull request updates the local-antora-playbook.yml file to ensure the correct branch is tracked for the redpanda-data/cloud-docs repository.

Branch updates:

  • local-antora-playbook.yml: Changed the tracked branch for redpanda-data/cloud-docs from 'DOC-1404-Document-new-configurable-property' to 'main'.

Resolves https://redpandadata.atlassian.net/browse/DOC-1449
Review deadline:

Page previews

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner June 15, 2025 20:35
Copy link

netlify bot commented Jun 15, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit bfe0ca4
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/684f2e9c7d668100089717ec
😎 Deploy Preview https://deploy-preview-1164--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 project configuration.

Copy link
Contributor

coderabbitai bot commented Jun 15, 2025

📝 Walkthrough

Walkthrough

The change updates the local-antora-playbook.yml configuration file by modifying the branch reference for the cloud-docs content source from 'DOC-1404-Document-new-configurable-property' back to 'main'. No other content sources or configuration settings are altered in this update.

Assessment against linked issues

Objective Addressed Explanation
Revert playbook back from cloud PR (DOC-1449)
Document new configurable property, including performance note (DOC-1404) No documentation or notes about the new configurable property are present in this change.

Possibly related PRs

  • DOC-1407 single source additions for Cloud #1139: The main PR reverses the branch reference change made in the retrieved PR within the same local-antora-playbook.yml file, directly affecting the same configuration setting for the cloud-docs content source.

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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

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)
local-antora-playbook.yml (1)

20-20: YAML style nit: unify branch declarations
We mix scalar (branches: 'main') and unquoted (branches: main) values and lists (branches: [v/*,…]). For clarity, consider using a consistent format—e.g., branches: [main]—and uniform quoting.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9d666a8 and bfe0ca4.

📒 Files selected for processing (1)
  • local-antora-playbook.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
local-antora-playbook.yml (1)

20-20: Reverted cloud-docs to track the main branch
This aligns with DOC-1449 by restoring the primary branch reference for the remote content source.

@micheleRP micheleRP merged commit 002955c into main Jun 15, 2025
7 checks passed
@micheleRP micheleRP deleted the DOC-1449-revert-playbook branch June 15, 2025 22:25
JakeSCahill pushed a commit that referenced this pull request Jul 15, 2025
JakeSCahill pushed a commit that referenced this pull request Jul 15, 2025
JakeSCahill pushed a commit that referenced this pull request Jul 15, 2025
paulohtb6 pushed a commit that referenced this pull request Jul 15, 2025
paulohtb6 pushed a commit that referenced this pull request Jul 15, 2025
paulohtb6 pushed a commit that referenced this pull request Jul 30, 2025
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.

2 participants