Skip to content

auto-docs: Update @redpanda-data/docs-extensions-and-macros#1726

Merged
Feediver1 merged 2 commits into
mainfrom
update/docs-extensions-and-macros-main
Jun 3, 2026
Merged

auto-docs: Update @redpanda-data/docs-extensions-and-macros#1726
Feediver1 merged 2 commits into
mainfrom
update/docs-extensions-and-macros-main

Conversation

@vbotbuildovich
Copy link
Copy Markdown
Contributor

This PR updates @redpanda-data/docs-extensions-and-macros using npm update.

@vbotbuildovich vbotbuildovich requested a review from a team as a code owner June 2, 2026 16:25
@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 2, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit bc5040b
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a20697056c52000088f1f00
😎 Deploy Preview https://deploy-preview-1726--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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 2, 2026

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 227758db-bbf9-40a1-956a-ccb9dd544478

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update/docs-extensions-and-macros-main

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

Copy link
Copy Markdown
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

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

Docs standards review (automated dep bump, main)

Files reviewed: 1 (package-lock.json, +3/-3). Not an .adoc content PR — automated dependency-bump bot PR. Sibling of #1727 (which targets the v/24.3 branch); this one targets main.

What this PR does

Bumps @redpanda-data/docs-extensions-and-macros on main from 5.0.05.0.3. Only the lockfile changes (the package.json constraint already allows the 5.0.x range). The three patch versions that get pulled in actually carry meaningful behavior changes:

Source PR What landed When
extensions#201 (merged 2026-06-02 16:23) False-positive "new connector" fix (symmetric augmentation in diff-generation), prometheus {} fix in common config YAML, Self-Managed → Streaming title comparison fix, + the Python C++ numeric-constant resolver work that was supposed to live in #202 Produced 5.0.3
extensions#199 (merged 2026-05-27) Fix old component name in attribute replacer extension Likely 5.0.1 or 5.0.2
extensions#197 (merged 2026-05-26) Add unified navigation extension and update component references Likely 5.0.1 or 5.0.2

Critical issues

None.

Suggestions

  1. 5.0.0 → 5.0.3 actually carries substantive behavior changes beyond a typical patch bump:

    • Connector docs generation is more accurate (no spurious "new connector" reports for CGO-only components)
    • Prometheus metrics config YAML now renders with {} instead of an empty dangling key
    • The Python C++ numeric-constant resolver is in (DOC-2137 territory) — property docs that referenced DEFAULT_TOPIC_MEMORY_PER_PARTITION will now resolve to "200 KiB (204800)" style values when regenerated
    • Streaming component title comparison is fixed in the attribute replacer

    So while this is technically a patch-version bump, the next time someone runs gen-props, gen-connectors, or similar generators against main, the output may diff vs. the previous version. Worth flagging in case anyone reviewing this assumes "patch bump = no behavior change."

  2. What 5.0.3 does NOT contain: the available-properties-tag and available-connect-version attributes from extensions#200, which is still open. The consumer-side docs-ui#384 depends on those attributes for its fallback chain. So merging this PR doesn't unblock docs-ui#384 — both extensions#200 and docs-ui#384 still need to land. Worth knowing for cross-repo coordination.

  3. Same auto-merge process question as #1727 — routine dep updates with green CI sit too long. This PR is 1 day old, which is reasonable, but the v/24.3 sibling has been waiting longer.

  4. PR description is minimal"This PR updates @redpanda-data/docs-extensions-and-macros using npm update.". A link to the source PRs that produced the new version (e.g., extensions#201) would help reviewers know what's actually changing. Out of scope here; bot-config tweak.

Impact on other files

  • No .adoc content changes, but the extension upgrade affects every page rendered by docs-extensions-driven mechanisms:

    • Connector docs pages (any auto-generated connector reference under modules/components/)
    • Property docs pages (auto-generated property tables that reference C++ constants)
    • Prometheus config examples in YAML callouts
  • Worth eyeballing the deploy preview for at least:

    • A connector-docs page (e.g., develop/connect/components/inputs/kafka_franz.adoc)
    • A property-reference page that uses numeric defaults (anything that historically rendered a constant name like DEFAULT_TOPIC_MEMORY_PER_PARTITION)
    • A Prometheus metrics config block

    to confirm the new generator output looks right.

  • No nav.adoc, xrefs, or page semantics affected directly by the bump.

CodeRabbit findings

None — CodeRabbit doesn't post on package-lock-only diffs.

What works well

  • All CI green, including Netlify deploy-preview. The build exercises the new extension version end-to-end.
  • Single-file lockfile-only diff — easy to revert if anything regresses.
  • Source PRs that produced 5.0.3 are reviewable in the extensions repo (#201) — chain of trust intact even if this PR's description is terse.

Verdict

Routine bot bump, but with meaningfully more behavior change packed in than the version delta suggests. Probably safe to merge after a one-minute deploy-preview check on a connector page + property page, knowing that ANY future gen-* regeneration on main will use the new behavior (different connector-diff handling, prometheus {}, constant resolution).

@Feediver1 Feediver1 merged commit b5812a7 into main Jun 3, 2026
7 checks passed
@Feediver1 Feediver1 deleted the update/docs-extensions-and-macros-main branch June 3, 2026 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants