Skip to content

chore: bump docs-extensions-and-macros to v5 and wire new extensions#599

Merged
kbatuigas merged 2 commits into
mainfrom
chore/docs-extensions-v5
May 26, 2026
Merged

chore: bump docs-extensions-and-macros to v5 and wire new extensions#599
kbatuigas merged 2 commits into
mainfrom
chore/docs-extensions-v5

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

Add conditional-home-redirect and unified-navigation extensions, and extend docs-site start_paths with data-platform and self-managed.

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)

Add conditional-home-redirect and unified-navigation extensions, and
extend docs-site start_paths with data-platform and self-managed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kbatuigas kbatuigas requested a review from a team as a code owner May 26, 2026 18:58
@netlify
Copy link
Copy Markdown

netlify Bot commented May 26, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 1e3e3a5
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a161293fe564200083de7d6
😎 Deploy Preview https://deploy-preview-599--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
Copy Markdown
Contributor

coderabbitai Bot commented May 26, 2026

Review Change Stack

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.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a8992fff-9358-4ca5-b768-49e1df961319

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

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR updates the Antora documentation configuration to support navigation enhancements and multiple content sources. The primary change expands start_paths in the content source to include data-platform and self-managed alongside home. Two new extensions are added to the Antora pipeline: a conditional home page redirect extension and a unified, config-driven navigation extension. The @redpanda-data/docs-extensions-and-macros dependency is bumped from ^4.0.0 to ^5.0.0 to provide these new extensions, and the extension ordering is adjusted accordingly.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • micheleRP
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description addresses the main change but includes incomplete template sections: the issue number placeholder is not filled in, page previews are missing, review deadline is blank, and no checks are selected. Fill in the issue number reference, add page preview links if applicable, specify a review deadline, and select appropriate checks from the template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: bumping docs-extensions-and-macros to v5 and configuring new extensions in the playbook.
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
  • Commit unit tests in branch chore/docs-extensions-v5

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

Align with renames already on main: redpanda-cloud -> cloud-data-platform
in start_page, and ROOT/redpanda-labs -> streaming/labs in
replace-attributes-in-attachments.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@kbatuigas kbatuigas merged commit 2348fdf into main May 26, 2026
6 checks passed
@kbatuigas kbatuigas deleted the chore/docs-extensions-v5 branch May 26, 2026 22:40
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