Repository navigation
v5.46.0
Published to npm as @redpanda-data/docs-extensions-and-macros@5.46.0. Prefer pinning reusable workflows and actions from this repository to the commit this tag points at: until a refs/tags/v* ruleset blocks tag updates, a tag can be re-pointed without review.
What's Changed
- Build glossary from terms in partial Asciidoc files by @JakeSCahill in #1
- Update package.json by @JakeSCahill in #2
- Bump version by @JakeSCahill in #3
- Add GH Action to publish to npm by @JakeSCahill in #5
- Add tests by @JakeSCahill in #4
- Fix GitHub Action by @JakeSCahill in #6
- Remove support for local-terms attribute by @JakeSCahill in #7
- test gh action by @Deflaimun in #8
- Fix bug that caused Maximum call stack size exceeded error by @JakeSCahill in #9
- Add test for latest versions by @JakeSCahill in #10
- Improve logging in Algolia extension by @JakeSCahill in #11
- Open Helm values in new window by @JakeSCahill in #12
- Remove images from Algolia index by @JakeSCahill in #13
- Format config properties as code by @JakeSCahill in #14
- Lower log level for missing glossary page by @JakeSCahill in #15
- Skip index for pages with no H1 by @JakeSCahill in #16
- feat: add support for setting line numbers on code blocks by @JakeSCahill in #17
- Improve Algolia indexer by @JakeSCahill in #18
- Fix version fetcher for Console version by @JakeSCahill in #19
- Add article text to the index by @JakeSCahill in #20
- Add support for glossary categories by @JakeSCahill in #21
- Allow no index pages by @JakeSCahill in #22
- Add data to schema by @JakeSCahill in #23
- Delete old records by @JakeSCahill in #24
- Allow users to override global attributes by @JakeSCahill in #26
- Add unix timestamp to doc records by @JakeSCahill in #27
- Fetch latest RP Operator version and set in attribute by @JakeSCahill in #28
- Add a category validator and related resource finder by @JakeSCahill in #29
- Export new extensions by @JakeSCahill in #30
- Return the latest semver tag by @JakeSCahill in #31
- Fix Octokit major.minor version by @JakeSCahill in #32
- Add product name and/or version to Algolia tags by @JakeSCahill in #33
- Use display version for prelease by @JakeSCahill in #34
- Bump version by @JakeSCahill in #35
- Add redirect modifier by @JakeSCahill in #36
- Handle redirect loops for all redirect strategies by @JakeSCahill in #37
- Add support for custom glossary link text by @JakeSCahill in #38
- Enable writers to define pages that should not be published by @JakeSCahill in #40
- Get latest Helm chart version by @JakeSCahill in #39
- Return the latest version of Redpanda by @JakeSCahill in #42
- Update path to Tiered Storage configs for Kubernetes by @JakeSCahill in #43
- Make sure to exclude RC releases by @JakeSCahill in #44
- Extensions and macros for filtering and categorizing Connect components by @JakeSCahill in #45
- Add support for query params for component table by @JakeSCahill in #46
- Add Enterprise labels and update support levels for each connector by @JakeSCahill in #47
- Fix trailing space on tags by @JakeSCahill in #48
- Add the latest release tag for redpanda-data/connect to playbook by @JakeSCahill in #49
- Unpublish beta pages when beta docs go GA by @JakeSCahill in #51
- Check for existence of attributes to avoid errors by @JakeSCahill in #52
- improve error handling in version fetcher by @JakeSCahill in #53
- Move data to Antora attributes so writers can update independently by @JakeSCahill in #50
- Move enterprise support definitions to antora.yaml file by @JakeSCahill in #55
- Add descriptions of labs to related-labs object by @JakeSCahill in #56
- gha: retrieve secrets from aws sm by @andrewhsu in #54
- Unpublish beta pages that aren't in a beta version by @JakeSCahill in #57
- Remove v prefix from RP Connect version tag by @JakeSCahill in #58
- Add the 'v' prefix back to the release tag for the connect repo by @JakeSCahill in #60
- Clarify which attributes are available in version fetcher extension by @JakeSCahill in #59
- Fix replacer extension to replace env vars with versions by @JakeSCahill in #61
- Fix regression by @JakeSCahill in #62
- Use component titles for all tags by @JakeSCahill in #64
- gha: retrieve secrets using oidc by @andrewhsu in #65
- Add Octokit core by @JakeSCahill in #66
- Bumps the version of the extensions so that a release is kicked off by @JakeSCahill in #67
- Trigger npm update in all repos on publish by @JakeSCahill in #68
- Fix version fetcher by @JakeSCahill in #70
- Modify connect component visualization by @Deflaimun in #69
- Add error handling to CSV handler by @JakeSCahill in #71
- Improvements to csv by @Deflaimun in #72
- adjust branch where the connect data is by @Deflaimun in #73
- Add back support for filtering for all enteprise connectors in query strings by @JakeSCahill in #75
- Set anchors to term titles by @JakeSCahill in #76
- Add support for local files by @JakeSCahill in #77
- DOC-549 Add support for a master component table and other metadata on connector docs by @JakeSCahill in #78
- DOC-611 Hide Enterprise license metadata in Cloud contexts by @JakeSCahill in #79
- DOC-700 Support beta in tests by @JakeSCahill in #80
- Fetch draft RC releases by @JakeSCahill in #81
- DOC-736 Fetch console beta releases by @JakeSCahill in #82
- DOC-725 Update rpcn macro to show all supported connectors by @asimms41 in #83
- Add support for hosting files at the site root by @JakeSCahill in #84
- DOC-672 Add an extension to collect Bloblang samples and make them available to the UI by @JakeSCahill in #85
- DOC-830 Update messaging for enterprise licenses by @asimms41 in #86
- DOC-721 Add extension to fetch data for index pages by @JakeSCahill in #87
- Do not logs warnings about missing logs for sql_driver_* connectors by @JakeSCahill in #88
- DOC-810 Consistent messaging for enterprise features by @asimms41 in #89
- Add archive attachments extension by @JakeSCahill in #90
- DOC-798 Add extension to calculate end-of-life date by @JakeSCahill in #92
- Fetch the latest Operator release from Docker Hub by @JakeSCahill in #94
- Fetch beta versions of the operator by @JakeSCahill in #95
- Add support for fetching the latest beta release of the Helm chart by @JakeSCahill in #96
- Fix custom replacements by @JakeSCahill in #97
- Do not use draft releases for latest Redpanda version by @JakeSCahill in #98
- Fetch Console tags from Docker Hub by @JakeSCahill in #100
- DOC-1022 Add macro for injecting structured data into docs by @JakeSCahill in #93
- DOC-1275 Add a doc-tools CLI command so that writers and our tests have access to a consistent set of tools by @JakeSCahill in #99
doc-tools link-readmeCLI command by @JakeSCahill in #101- Use options for link-readme CLI command by @JakeSCahill in #102
- DOC-1387 Add Kubernetes automations to the CLI by @JakeSCahill in #103
- DOC-1022 Automation for Redpanda Connect reference docs by @JakeSCahill in #105
- Do not generate drafts or log missing for deprecated components by @JakeSCahill in #106
- Fix rendering of fields by @JakeSCahill in #108
- Add macro for inline badges by @JakeSCahill in #109
- RPCN automation: Fail fast and check dependencies early by @JakeSCahill in #110
- Fix the Helm chart version fetcher by @JakeSCahill in #111
- Allow for unknown types by @JakeSCahill in #112
- Handle unknown types by @JakeSCahill in #113
- Fix tree-sitter version compatibility for property docs generation by @JakeSCahill in #114
- Fix the syntax error in property extractor tool by @JakeSCahill in #115
- Improve troubleshooting info for missing dev tools on macos by @JakeSCahill in #116
- Add context switcher extension for automated cross-page navigation by @JakeSCahill in #117
- Add commander as a dependency by @JakeSCahill in #121
- Bump version by @JakeSCahill in #122
- Add an automation to generate a table of cloud regions by @JakeSCahill in #119
- Properties aliases by @paulohtb6 in #123
- DOC-583 Replace multi-select tags with checkbox dropdowns by @JakeSCahill in #124
- Use latest prod UI and bump version to 4.7.2 by @JakeSCahill in #125
- Do not create a tag for the Home component by @JakeSCahill in #127
- Avoid tagging with utility component titles by @JakeSCahill in #128
- Topic properties auto by @paulohtb6 in #126
- DOC-1455 End to end config property automation by @JakeSCahill in #129
- Fetch data about editable and readonly config properties in Cloud by @JakeSCahill in #130
- Improve the Redpanda Connect automation by @JakeSCahill in #132
- Add a CLI command that generates OpenAPI spec files from proto files by @JakeSCahill in #134
- Add dynamic lookup for enterprise SASL mechanisms from source code by @JakeSCahill in #137
- Enable manual trigger for npm publish by @JakeSCahill in #139
- Add support for saving properties to partials by @JakeSCahill in #140
- Do not generate property docs for deprecated properties by @JakeSCahill in #141
- Add support for excluding properties from docs (using Asciidoc tags) by @JakeSCahill in #142
- Add comments to autogenerated content by @JakeSCahill in #143
- Enable bundle-openapi CLI to process any branch by @JakeSCahill in #144
- Use Antora config to determine current version by @JakeSCahill in #145
- Support related topics for cloud/self-managed only by @JakeSCahill in #147
- DOC-1576 Convert docs to Markdown and publish alongside HTML by @JakeSCahill in #148
- Add a marker to confirm to the UI that the markdown extension ran by @JakeSCahill in #151
- Property Extractor: Automated Type Resolution and Comprehensive Enum Extraction by @JakeSCahill in #149
- Redpanda Connect automation fixes and improvements by @JakeSCahill in #152
- Fix object Object bug in RPCN automation by @JakeSCahill in #153
- Improve topic property mappings and filter experimental properties by @JakeSCahill in #154
- Fix property extractor incorrectly reading runtime mutability as default by @JakeSCahill in #155
- Fix property extraction and documentation formatting by @JakeSCahill in #156
- gha: update publish-to-npm (using OIDC now) by @clee in #158
- Fix the Helm version fetcher with the corrected paths to the chart by @JakeSCahill in #159
- gha: bump node version by @clee in #160
- Doc Tools MCP Server by @JakeSCahill in #157
- Fix MCP server by including mcp directory in npm package. by @JakeSCahill in #161
- Improve Redpanda Connect automations using feedback from docs team by @JakeSCahill in #162
- Fix Redpanda Connect cloud-only connector automation by @JakeSCahill in #163
- Fix Redpanda Connect cloud-only connector automation by @JakeSCahill in #164
- Fix/array of objects and cloud docs check by @JakeSCahill in #166
- fix: Add ACTIONS_BOT_TOKEN and VBOT_GITHUB_API_TOKEN to token check by @JakeSCahill in #167
- Remove migrated prompts, resources, and templates by @JakeSCahill in #165
- fix: Use QUOTE_DOUBLE for YAML strings to prevent misleading block scalars by @JakeSCahill in #168
- properties: obligates script to pull from dev before running by @paulohtb6 in #171
- Deprecated props by @paulohtb6 in #172
- Add convert-llms-to-txt extension for agent-friendly docs by @JakeSCahill in #173
- Fix URL encoding in llms.txt (em dashes to hyphens) by @JakeSCahill in #174
- Fix zero-width spaces in llms.txt URLs by @JakeSCahill in #175
- opt out of AI training per GitHub policy by @rpdevmp in #177
- AI optimization: frontmatter exports and component-specific full.txt files by @JakeSCahill in #178
- Export git-full-clone extension by @JakeSCahill in #180
- Fix local playbook by @JakeSCahill in #181
- fix: place frontmatter after H1 heading in markdown exports by @JakeSCahill in #182
- feat: Redpanda Connect connector docs automation with multi-release attribution by @JakeSCahill in #183
- fix: use bloblang syntax highlighting instead of coffeescript by @JakeSCahill in #184
- fix: prevent false removed connectors in diff by stripping augmentation fields by @JakeSCahill in #185
- Improve agent-friendly docs compliance by @JakeSCahill in #186
- Wrap
$refwith sibling properties inallOfduring OpenAPI spec bundling by @kbatuigas in #179 - Bump version from PR 179 by @kbatuigas in #188
- feat: improve AI-readiness with llms.txt directive and sitemap enhancements by @JakeSCahill in #187
- fix: ensure llms directive HTML matches afdocs test pattern by @JakeSCahill in #189
- fix: correct AsciiDoc heading levels in bloblang examples by @JakeSCahill in #190
- fix: correct three bugs in Redpanda Connect connector documentation generation by @JakeSCahill in #191
- generate-fields-only-pages: scope default attachment discovery to components module with versioned filename regex by @JakeSCahill with @Copilot in #192
- fix: skip field-only pages in unlisted pages check by @JakeSCahill in #194
- Add page-support-months attribute to EOL computation by @JakeSCahill in #195
- Add unified navigation extension and update component references by @JakeSCahill in #197
- fix: augment intermediate diff data with binary analysis results by @JakeSCahill in #196
- Fix old component name in attribute replacer extension by @JakeSCahill in #199
- fix: connector docs automation fixes (false positives + prometheus {}) by @JakeSCahill in #201
- Add available-properties-tag and available-connect-version attributes by @JakeSCahill in #200
- DOC-2220: comprehensive rpk documentation automation system by @JakeSCahill in #203
- DOC-1878: Chunk long reference pages for Algolia indexing by @JakeSCahill in #205
- Bump version to 5.1.1 by @JakeSCahill in #206
- fix(rpk-docs): pin Docker Go image to go.mod version and fix schema validator path by @JakeSCahill in #207
- fix(rpcn-docs): whats-new xref truncation and config-component cloud metadata by @JakeSCahill in #208
- fix(cli): make rpk binary download resilient to transient errors by @JakeSCahill in #209
- feat(connect): extract connector metadata sections into regenerated partials by @JakeSCahill in #210
- fix(rpk-docs): preserve continuation indent in examples; add k8s plugin by @JakeSCahill in #211
- fix(property-docs): stamp Introduced-in versions before AsciiDoc generation by @JakeSCahill in #214
- fix: render connector sticky-bar metadata server-side, keep license notice visible by @JakeSCahill in #216
- fix(connect): metadata migration swallows trailing fields include + single-source tag by @JakeSCahill in #217
- feat(connect): normalize metadata partial field-list formatting by @JakeSCahill in #218
- fix(connect): render map fields as object in field reference by @JakeSCahill in #220
- fix(property-extractor): derive property names from the registered name literal, not the C++ member by @JakeSCahill in #233
- feat(rpk-docs): refresh a single plugin's docs with --plugin by @JakeSCahill in #225
- feat(rpk-docs): gate subcommand table rows by cloud availability by @JakeSCahill in #229
- fix(rpk-docs): restore Linux-only platform detection on Linux CI runners by @JakeSCahill in #226
- Host-platform container builds and unsatisfiable env-gating validation by @JakeSCahill in #238
- Reject unsupported host platforms in the container build fallback by @JakeSCahill in #239
- fix(property-extractor): resolve member calls on inline constants in defaults by @JakeSCahill in #228
- fix(property-docs): stop --diff runs from overwriting the committed baseline by @JakeSCahill in #232
- fix(property-docs): harden the property extraction pipeline by @JakeSCahill in #234
- Honor --path when locating the Redpanda source in the property extractor by @JakeSCahill in #237
- Fix rpai in inline code spans and half-backticked command paths by @JakeSCahill in #241
- Warn when a rerender drops a page's Flags section by @JakeSCahill in #240
- Add end-to-end testing guidelines for automations by @JakeSCahill in #235
- fix(connect): emit context-switcher as array and pass URL entries through by @JakeSCahill in #230
- fix(connect): emit fragment anchors matching rendered heading IDs in whats-new links by @JakeSCahill in #223
- feat: point UI meta tags at JSON attachments that actually exist by @JakeSCahill in #224
- Release 5.3.6: export the set-available-attachment-versions extension by @JakeSCahill in #244
- feat(rpcn): warn when regenerating a metadata partial drops published sections by @JakeSCahill in #236
- feat(rpk-stubs): copy the partial description into created stub headers by @micheleRP in #245
- DOC-2303: Authenticate git-full-clone unshallow fetches for private repos by @JakeSCahill in #252
- fix(extensions): stop MaxListenersExceededWarning in production builds by @JakeSCahill in #250
- Let single-source stubs inherit descriptions as header attributes by @JakeSCahill in #246
- feat(macros): enterprise inline macro for marking enterprise features (DOC-887) by @JakeSCahill in #249
- feat(extensions): build-time URL-to-xref conversion and external link checking by @JakeSCahill in #247
- feat(rpk-docs): add rpk-env-partial generator command by @JakeSCahill in #256
- feat(helm-spec): document commented-out values from values.yaml by @JakeSCahill in #248
- Fix setup-mcp: add --package flag so npx can resolve doc-tools-mcp bin by @Feediver1 in #198
- fix(ci): isolate the CGO network test and report download failures honestly by @JakeSCahill in #259
- fix(validate): honor --skip-connect for antora.yml and authenticate private fetches by @JakeSCahill in #260
- fix(redpanda-connect): avoid rpk connect upgrade's version-regex bug in report-delta by @JakeSCahill in #257
- fix(prop): keep property tooltips and links inside the reader's own doc set by @JakeSCahill in #265
- fix(props): stop topic property docs emitting links Cloud readers cannot follow by @JakeSCahill in #269
- fix(prop,enterprise): defects found by adversarial review of #265 by @JakeSCahill in #266
- ci: add reusable guard workflow for generated files by @JakeSCahill in #263
- fix(unified-navigation): read component metadata from the latest release, not the prerelease by @JakeSCahill in #272
- fix(redpanda-connect): recursively detect new fields nested under existing groups by @JakeSCahill in #258
- fix(redpanda-connect): fetch historical schemas from release assets, not rpk by @JakeSCahill in #268
- fix(extensions): stop the property attachment corrupting 64-bit values, and render descriptions with Antora by @JakeSCahill in #270
- feat(rpcn): regenerate a per-connector description partial (prototype) by @JakeSCahill in #227
- feat(cloud-regions): honor custom templates and add --cluster-type filter by @JakeSCahill in #262
- fix(version-fetcher): skip draft releases when resolving Redpanda and Console versions by @JakeSCahill in #271
- feat(version-fetcher): emit -version-short attributes by @JakeSCahill in #255
- fix(enterprise): gate a feature's since version against the page's own version by @JakeSCahill in #277
- feat: add sync-schemas command to keep content-repo schemas current by @JakeSCahill in #275
- doc-tools: lint-strings, preview-string, overrides-audit, and the reusable doc-strings review by @JakeSCahill in #264
- feat(prop): move related-topics conditionals to a structured, validated see_also field by @JakeSCahill in #274
- fix(llms): stop advertising component exports that 404 by @kbatuigas in #284
- fix(glossary): escape hover-text for HTML tooltip attributes by @micheleRP in #289
- fix(extensions): delete the drifted fork of @antora/redirect-producer by @JakeSCahill in #273
- fix(redpanda-connect): rename description partial's header tag from attrs to meta by @JakeSCahill in #280
- refactor(macros): log through @antora/logger instead of console.warn by @JakeSCahill in #283
- fix(rpk-docs): add missing blank line before the next heading in what's-new merges by @JakeSCahill in #285
- feat(property-extractor): add structured admonitions override field by @JakeSCahill in #279
- fix(doc-strings-review): OIDC bot token, credential scoping, and opt-in ADP gateway auth by @JakeSCahill in #294
- feat(doc-strings-review): gate the Claude pass on touched declarations, not lint findings by @JakeSCahill in #297
- fix(link-check): stop reporting code blocks, comments and unresolved attributes by @JakeSCahill in #301
- fix(doc-tools): resolve GitHub tokens consistently and migrate source automations to streaming-enterprise by @JakeSCahill in #276
- feat(property-extractor): replace C++-source parsing with rp_util runtime introspection by @JakeSCahill in #278
- feat(lint-strings): add the api surface for the OpenAPI-generating protos by @JakeSCahill in #300
- fix(github-token): prefer named API tokens over GIT_CREDENTIALS for REST calls by @JakeSCahill in #310
- DOC-1807: Kapa source groups for version-scoped docs answers by @JakeSCahill in #305
- fix(link-check): skip indented literal paragraphs by @JakeSCahill in #311
- ci: don't build rp_util for a tag whose scopes it cannot dump by @JakeSCahill in #314
- fix: stop the CRD and property generators emitting AsciiDoc that warns by @JakeSCahill in #315
- fix(property-docs): wait for a schema that is coming, degrade for one that never will by @JakeSCahill in #318
- fix: guarantee every property gets a category, so none vanish from category-tag pages by @JakeSCahill in #288
- fix(preview-string): register property-extractor Handlebars helpers before rendering property.hbs by @JakeSCahill in #296
- fix(property-extractor): stop fabricated properties defaulting to topic scope by @JakeSCahill in #309
- feat: add upstream_ref field to property and rpk overrides schemas by @JakeSCahill in #290
- fix: publish property-overrides.schema.json in the npm package by @JakeSCahill in #286
- fix(lint-strings): only ask about a default when it is a sentinel by @JakeSCahill in #316
- fix(enterprise): Redpanda Cloud has no Enterprise Edition license concept by @JakeSCahill in #293
- Warn on reverted copy, lint house style at source, fix what's-new spacing by @JakeSCahill in #306
- fix(rpk-docs): stop swallowing adjacent punctuation into a merged env-var path by @JakeSCahill in #292
- feat(doc-strings-review): resolve the doc-tools version from the workflow's own ref by @JakeSCahill in #298
- fix(render-property-descriptions): resolve legacy dot-free anchors to the documented property by @JakeSCahill in #319
- fix(property-extractor): materialize the gets_restored default so both rp_util paths render by @JakeSCahill in #321
- feat(rpk): download rpk binaries from rpk.redpanda.com instead of GitHub releases by @JakeSCahill in #317
- feat(macros): add a hands-on course and lightweight showcase for prop:/enterprise: by @JakeSCahill in #281
- feat(rpk-docs): section the -X env var table by the API rpk reports (5.44.0) by @JakeSCahill in #322
- fix(rpk-plugin-stubs): authenticate the docs-repo clone (5.44.1) by @micheleRP in #323
- feat(lint-screenshots): promote the cloud-docs screenshot linter into doc-tools by @Feediver1 in #313
- feat(doc-strings-review): mint as the doc-strings-review agent so spend attributes to it by @JakeSCahill in #312
- ci: tag and release every version published to npm by @JakeSCahill in #307
New Contributors
- @Deflaimun made their first contribution in #8
- @andrewhsu made their first contribution in #54
- @asimms41 made their first contribution in #83
- @paulohtb6 made their first contribution in #123
- @clee made their first contribution in #158
- @rpdevmp made their first contribution in #177
- @kbatuigas made their first contribution in #179
- @JakeSCahill with @Copilot made their first contribution in #192
- @micheleRP made their first contribution in #245
- @Feediver1 made their first contribution in #198
Full Changelog: https://github.com/redpanda-data/docs-extensions-and-macros/commits/v5.46.0