Skip to content

Conversation

@paulohtb6
Copy link
Contributor

Description

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

Checks

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

@paulohtb6 paulohtb6 requested a review from a team as a code owner October 15, 2025 17:20
@netlify
Copy link

netlify bot commented Oct 15, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit b7e8376
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68efd7cee5594d00080bc32d
😎 Deploy Preview https://deploy-preview-434--rp-cloud.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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 15, 2025

📝 Walkthrough

Walkthrough

The PR updates antora.yml navigation: the "Cloud API quickstart" entry changes its target from an absolute path (/api/doc/...) to a link: URL (link:/api/doc/...). No other configuration or content changes are made, and no public APIs are affected.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • Update antora.yml #433: Also changes the "Cloud API quickstart" navigation entry to adjust the link target/format in antora.yml.
  • Fix missing link text #398: Adjusts AsciiDoc link usage to use link:/… syntax with explicit display text, similar link-formatting change.

Suggested reviewers

  • micheleRP

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The description mirrors the template but has not been filled out: the issue number is a placeholder, the review deadline is blank, no page preview links are provided, and no checkboxes are marked, so the required information is missing. Please fill in the actual issue number in the Resolves line, specify a review deadline, add the Netlify page preview links for the changed pages, and select the appropriate checkboxes (e.g., Small fix) to complete the template.
Title Check ❓ Inconclusive The title "fix link" is related to the change but is too generic and does not specify which link or context is being corrected, making it unclear for someone scanning the history. Please update the title to clearly reference the specific link and its location, for example “Fix Cloud API quickstart link in navigation.”
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch use-link

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between fcaa90d and b7e8376.

📒 Files selected for processing (1)
  • antora.yml (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - rp-cloud
  • GitHub Check: Header rules - rp-cloud
  • GitHub Check: Pages changed - rp-cloud

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.

Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

lgtm

@paulohtb6 paulohtb6 merged commit 63a5740 into main Oct 20, 2025
5 checks passed
@paulohtb6 paulohtb6 deleted the use-link branch October 20, 2025 21:12
paulohtb6 added a commit that referenced this pull request Oct 20, 2025
This reverts commit 63a5740.
@paulohtb6 paulohtb6 mentioned this pull request Oct 20, 2025
paulohtb6 added a commit that referenced this pull request Oct 20, 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.

3 participants