@redpanda-data/docs-extensions-and-macros 5.54.0 → 5.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/doc-tools-mcp.js +4 -5
- package/bin/doc-tools.js +354 -9
- package/bin/mcp-tools/generated-docs-review.js +26 -9
- package/bin/mcp-tools/overrides-audit.js +1 -1
- package/bin/mcp-tools/rpcn-docs.js +4 -14
- package/cli-utils/docs-links-to-xrefs.js +174 -0
- package/cli-utils/format-helm-spec.js +4 -3
- package/cli-utils/generated-marker.js +43 -0
- package/cli-utils/helm-commented-values.js +125 -21
- package/cli-utils/self-managed-docs-branch.js +36 -30
- package/extension-utils/html-utils.js +27 -0
- package/extension-utils/llms-utils.js +6 -2
- package/extension-utils/metadata-candidates.js +304 -0
- package/extension-utils/metadata-check.js +174 -0
- package/extension-utils/metadata-suggest.js +573 -0
- package/extension-utils/taxonomy-categories.js +106 -0
- package/extension-utils/taxonomy.js +566 -0
- package/extensions/REFERENCE.adoc +110 -8
- package/extensions/add-git-dates.js +13 -1
- package/extensions/aggregate-terms.js +34 -20
- package/extensions/algolia-indexer/generate-index.js +13 -1
- package/extensions/algolia-indexer/index.js +4 -2
- package/extensions/convert-sitemap-to-markdown.js +47 -12
- package/extensions/convert-to-markdown.js +176 -0
- package/extensions/generate-fields-only-pages.js +14 -0
- package/extensions/modify-connect-tag-playbook.js +181 -3
- package/extensions/resolve-xrefs-in-attachments.js +1 -12
- package/extensions/url-to-xref.js +92 -22
- package/extensions/util/connect-docs-asset.js +6 -5
- package/extensions/validate-attributes.js +10 -1
- package/extensions/version-fetcher/fetch-latest-docker-tag.js +35 -13
- package/extensions/version-fetcher/get-latest-redpanda-helm-version-from-operator.js +64 -40
- package/extensions/version-fetcher/list-connect-releases.js +3 -3
- package/extensions/version-fetcher/release-lines.js +64 -0
- package/extensions/version-fetcher/set-latest-version.js +73 -3
- package/macros/README.adoc +1 -0
- package/macros/REFERENCE.adoc +99 -0
- package/macros/badge.js +5 -8
- package/macros/enterprise.js +2 -5
- package/macros/glossary.js +4 -14
- package/macros/iceberg-explorer.js +242 -0
- package/macros/prop.js +3 -13
- package/mcp/USER_GUIDE.adoc +25 -135
- package/package.json +5 -2
- package/tools/check-metadata/index.js +523 -0
- package/tools/cloud-regions/cloud-regions-table-adoc.hbs +1 -2
- package/tools/cloud-regions/cloud-regions-table-md.hbs +2 -2
- package/tools/cloud-regions/render-cloud-regions.js +3 -0
- package/tools/dispatch-graph/check-dispatch-graph.js +790 -0
- package/tools/dispatch-graph/classify-runs.js +128 -0
- package/tools/dispatch-graph/parse-workflows.js +499 -0
- package/tools/doc-impact-recording/index.js +190 -0
- package/tools/enterprise-features/detect-gating-changes.js +393 -0
- package/tools/enterprise-features/verify.js +2 -1
- package/tools/gen-rpk-ascii.py +7 -1
- package/tools/lint-strings/fixtures/connect/lint_connect.go +8 -0
- package/tools/lint-strings/fixtures/crd/lint_types.go +4 -1
- package/tools/lint-strings/fixtures/rpk-pr461/delete.base.go +42 -0
- package/tools/lint-strings/fixtures/rpk-pr461/delete.head.go +45 -0
- package/tools/lint-strings/fixtures/rpk-pr461/reviewer-comments.json +1 -0
- package/tools/lint-strings/index.js +133 -3
- package/tools/lint-strings/rules/verbatim-asciidoc.js +166 -1
- package/tools/lint-strings/surfaces/connect.js +72 -12
- package/tools/lint-strings/surfaces/crd.js +10 -6
- package/tools/metrics/metrics.py +11 -0
- package/tools/overrides-audit/README.adoc +1 -2
- package/tools/overrides-audit/adapters/properties.js +1 -1
- package/tools/overrides-audit/index.js +3 -4
- package/tools/property-extractor/generate-handlebars-docs.js +9 -1
- package/tools/property-extractor/helpers/applyPropertyLinks.js +35 -0
- package/tools/redpanda-connect/AUTOMATION.md +3 -36
- package/tools/redpanda-connect/README.adoc +5 -33
- package/tools/redpanda-connect/generate-rpcn-connector-docs.js +32 -11
- package/tools/redpanda-connect/pr-summary-formatter.js +6 -4
- package/tools/redpanda-connect/report-delta.js +6 -3
- package/tools/redpanda-connect/rpcn-connector-docs-handler.js +42 -25
- package/tools/redpanda-connect/templates/bloblang-function.hbs +1 -1
- package/tools/redpanda-connect/templates/descriptions-partials.hbs +1 -1
- package/tools/redpanda-connect/templates/examples-partials.hbs +1 -1
- package/tools/redpanda-connect/templates/fields-partials.hbs +2 -2
- package/tools/redpanda-connect/templates/metadata-partials.hbs +1 -1
- package/tools/redpanda-release-notes/generate-release-notes.js +116 -1
- package/tools/rpk-docs/generate-rpk-docs.js +2 -0
- package/tools/rpk-docs/generate-x-env-partial.js +7 -4
- package/tools/rpk-docs/helpers/index.js +4 -1
- package/tools/rpk-docs/templates/command.hbs +2 -2
- package/tools/overrides-audit/adapters/connect.js +0 -144
package/mcp/USER_GUIDE.adoc
CHANGED
|
@@ -200,24 +200,6 @@ The MCP server provides *writer-friendly tools* designed for natural language in
|
|
|
200
200
|
* Requires knowledge of doc-tools CLI syntax
|
|
201
201
|
* Only works in repos that have doc-tools installed
|
|
202
202
|
|
|
203
|
-
=== Contextual guides (prompts)
|
|
204
|
-
|
|
205
|
-
*property-docs-guide*:: Comprehensive guide for updating Redpanda property documentation
|
|
206
|
-
+
|
|
207
|
-
* Explains the auto-generation system and override workflow
|
|
208
|
-
* Provides rules for property descriptions (no cloud conditionals, no enterprise includes)
|
|
209
|
-
* Lists common scenarios and validation steps
|
|
210
|
-
* Claude automatically retrieves this when working with property documentation
|
|
211
|
-
* Ensures correct workflow: update property-overrides.json, not generated .adoc files
|
|
212
|
-
|
|
213
|
-
*rpcn-connector-docs-guide*:: Comprehensive guide for updating Redpanda Connect connector reference documentation
|
|
214
|
-
+
|
|
215
|
-
* Explains the override system with `$ref` syntax for DRY (Don't Repeat Yourself) principles
|
|
216
|
-
* Describes repository structure and how autogenerated content works with overrides
|
|
217
|
-
* Provides workflow for improving connector documentation
|
|
218
|
-
* Claude automatically retrieves this when working with connector documentation
|
|
219
|
-
* Ensures correct workflow: update docs-data/overrides.json, use $ref for deduplication
|
|
220
|
-
|
|
221
203
|
=== Background job management
|
|
222
204
|
|
|
223
205
|
Long-running documentation generation tasks support background execution with progress updates:
|
|
@@ -265,130 +247,38 @@ Background jobs send real-time progress notifications via MCP protocol, so Claud
|
|
|
265
247
|
|
|
266
248
|
All commands have a 10-minute timeout (increased from 5 minutes) to handle large documentation generation tasks.
|
|
267
249
|
|
|
268
|
-
==
|
|
269
|
-
|
|
270
|
-
The MCP server provides *AI consistency prompts* that help Claude follow your team's documentation standards automatically. These prompts are pre-configured instructions that guide Claude's responses for common documentation tasks.
|
|
271
|
-
|
|
272
|
-
=== Documentation review prompts
|
|
273
|
-
|
|
274
|
-
*review-for-style*:: Review documentation content for style guide compliance
|
|
275
|
-
+
|
|
276
|
-
* Checks: Style guide compliance, terminology consistency, voice/tone, AsciiDoc formatting
|
|
277
|
-
* Input: Content to review (can be file path or raw text)
|
|
278
|
-
* Output: Detailed feedback with critical issues, suggestions, and actionable recommendations
|
|
279
|
-
* Use when: Reviewing any documentation before publishing
|
|
280
|
-
|
|
281
|
-
*check-terminology*:: Validate terminology usage against approved team terminology
|
|
282
|
-
+
|
|
283
|
-
* Checks: Incorrect terms, deprecated terms (whitelist/blacklist, master/slave), inconsistent usage
|
|
284
|
-
* Input: Content to check
|
|
285
|
-
* Output: Critical issues with corrections, inconsistencies found, missing glossary links
|
|
286
|
-
* Use when: Ensuring consistent terminology across documentation
|
|
287
|
-
|
|
288
|
-
*improve-clarity*:: Refactor existing documentation for clarity and readability
|
|
289
|
-
+
|
|
290
|
-
* Applies: Style guide principles, simplifies complex explanations, improves structure
|
|
291
|
-
* Input: Content to improve
|
|
292
|
-
* Output: Refactored content with explanations of changes made
|
|
293
|
-
* Use when: Content is technically correct but difficult to understand
|
|
294
|
-
|
|
295
|
-
=== Content creation prompts
|
|
296
|
-
|
|
297
|
-
*write-new-guide*:: Generate a new tutorial or guide following team standards
|
|
298
|
-
+
|
|
299
|
-
* Applies: Team templates, approved terminology, voice/tone guidelines, AsciiDoc formatting
|
|
300
|
-
* Input: Topic (what to write about), optional audience (beginners, experienced devs, operators)
|
|
301
|
-
* Output: Complete guide following team standards
|
|
302
|
-
* Use when: Starting a new tutorial, how-to, or getting started guide
|
|
303
|
-
|
|
304
|
-
=== Workflow guide prompts
|
|
305
|
-
|
|
306
|
-
*property-docs-guide*:: Comprehensive guide for updating Redpanda property documentation
|
|
307
|
-
+
|
|
308
|
-
* Explains: Auto-generation system, override workflow, validation steps
|
|
309
|
-
* Rules: Never edit generated `.adoc` files, always update `property-overrides.json`
|
|
310
|
-
* Use when: Claude is helping with property documentation
|
|
311
|
-
* Claude automatically retrieves this prompt when working with properties
|
|
312
|
-
|
|
313
|
-
*rpcn-connector-docs-guide*:: Guide for updating Redpanda Connect connector documentation
|
|
314
|
-
+
|
|
315
|
-
* Explains: Override system with `$ref` syntax for DRY principles, repository structure
|
|
316
|
-
* Rules: Update `docs-data/overrides.json`, use `$ref` for deduplication
|
|
317
|
-
* Use when: Claude is helping with connector documentation
|
|
318
|
-
* Claude automatically retrieves this prompt when working with connectors
|
|
319
|
-
|
|
320
|
-
=== How to use prompts
|
|
250
|
+
== Guidance from docs-team-standards
|
|
321
251
|
|
|
322
|
-
|
|
252
|
+
This server provides tools and one resource. It has no MCP prompts. Writing, review, and workflow guidance lives in the https://github.com/redpanda-data/docs-team-standards[docs-team-standards^] Claude Code plugin:
|
|
323
253
|
|
|
324
|
-
|
|
254
|
+
[cols="1,2"]
|
|
255
|
+
|===
|
|
256
|
+
|Task |docs-team-standards
|
|
325
257
|
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
Claude: *retrieves and applies the review-for-style prompt*
|
|
329
|
-
*provides structured feedback following the prompt instructions*
|
|
330
|
-
----
|
|
331
|
-
|
|
332
|
-
*Implicit prompt usage:*
|
|
333
|
-
|
|
334
|
-
----
|
|
335
|
-
You: "Review this tutorial for our style guide"
|
|
336
|
-
Claude: *automatically uses review-for-style prompt*
|
|
337
|
-
*provides feedback based on your team standards*
|
|
338
|
-
----
|
|
339
|
-
|
|
340
|
-
*Listing available prompts:*
|
|
341
|
-
|
|
342
|
-
----
|
|
343
|
-
You: "List available prompts"
|
|
344
|
-
Claude: *shows all prompts with descriptions*
|
|
345
|
-
----
|
|
346
|
-
|
|
347
|
-
You can also preview prompts using the CLI:
|
|
258
|
+
|Review content for style, terminology, structure, and clarity
|
|
259
|
+
|The `review` skill, the `/review` command, or the `content-reviewer` agent
|
|
348
260
|
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
# Preview a review prompt
|
|
352
|
-
npx doc-tools preview-prompt review-for-style --content "Test content"
|
|
353
|
-
|
|
354
|
-
# Preview a write prompt
|
|
355
|
-
npx doc-tools preview-prompt write-new-guide --topic "Deploy cluster"
|
|
261
|
+
|Write a new page or guide
|
|
262
|
+
|The `page-templates` skill and the `/plan` command
|
|
356
263
|
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
264
|
+
|Update property documentation
|
|
265
|
+
|The `property-overrides` skill
|
|
266
|
+
|===
|
|
360
267
|
|
|
361
268
|
== Available resources
|
|
362
269
|
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
=== Style guide
|
|
366
|
-
|
|
367
|
-
*redpanda://style-guide*:: Redpanda Documentation Style Guide (v1.0.0)
|
|
270
|
+
*redpanda://personas*:: Target audience personas for the current repository
|
|
368
271
|
+
|
|
369
|
-
*
|
|
370
|
-
*
|
|
371
|
-
* Contains: Terminology quick reference, formatting examples, common patterns
|
|
372
|
-
* Claude automatically references this when reviewing or writing documentation
|
|
272
|
+
* Loaded from `docs-data/personas.yaml` in your current working directory
|
|
273
|
+
* Defines reader types, goals, pain points, and content preferences
|
|
373
274
|
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
Resources are automatically loaded by prompts, but you can also reference them explicitly:
|
|
377
|
-
|
|
378
|
-
*Explicit reference:*
|
|
275
|
+
To read it, ask Claude directly:
|
|
379
276
|
|
|
380
277
|
----
|
|
381
|
-
You: "Read the redpanda://
|
|
382
|
-
Claude: *reads the style guide resource*
|
|
383
|
-
*explains the code block formatting rules*
|
|
278
|
+
You: "Read the redpanda://personas resource and summarize the target readers"
|
|
384
279
|
----
|
|
385
280
|
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
----
|
|
389
|
-
You: "List available resources"
|
|
390
|
-
Claude: *shows all resources with descriptions and versions*
|
|
391
|
-
----
|
|
281
|
+
The style guide lives in docs-team-standards, not in this server.
|
|
392
282
|
|
|
393
283
|
=== Design philosophy
|
|
394
284
|
|
|
@@ -972,12 +862,12 @@ Suggestion: Check that the version exists in the Redpanda repository. You can fi
|
|
|
972
862
|
https://github.com/redpanda-data/streaming-enterprise/releases
|
|
973
863
|
----
|
|
974
864
|
|
|
975
|
-
=== Example 7: Property documentation updates
|
|
865
|
+
=== Example 7: Property documentation updates
|
|
976
866
|
|
|
977
867
|
----
|
|
978
868
|
You: Improve the description for cleanup.policy property to explain what each value does
|
|
979
869
|
|
|
980
|
-
Claude: *
|
|
870
|
+
Claude: *uses the property-overrides skill from docs-team-standards*
|
|
981
871
|
*reads property-overrides.json*
|
|
982
872
|
*updates the description field with enhanced explanation*
|
|
983
873
|
*uses generate_property_docs MCP tool with generate_partials: true*
|
|
@@ -995,7 +885,7 @@ The description now explains:
|
|
|
995
885
|
- `compact,delete` - Compaction + time-based deletion
|
|
996
886
|
----
|
|
997
887
|
|
|
998
|
-
|
|
888
|
+
The skill provides the property documentation workflow, so Claude updates the overrides file, not the generated files.
|
|
999
889
|
|
|
1000
890
|
=== Example 8: Review documentation for style compliance
|
|
1001
891
|
|
|
@@ -1004,7 +894,7 @@ You: Review this tutorial for style guide compliance:
|
|
|
1004
894
|
|
|
1005
895
|
[Content of tutorial pasted here]
|
|
1006
896
|
|
|
1007
|
-
Claude: *uses review-
|
|
897
|
+
Claude: *uses the review skill from docs-team-standards*
|
|
1008
898
|
*analyzes content against team style guide*
|
|
1009
899
|
|
|
1010
900
|
Style Review for Tutorial
|
|
@@ -1042,7 +932,7 @@ Overall: Good structure, clear explanations. Fix critical issues before publishi
|
|
|
1042
932
|
----
|
|
1043
933
|
You: Check the terminology in this doc for any deprecated or incorrect terms
|
|
1044
934
|
|
|
1045
|
-
Claude: *uses
|
|
935
|
+
Claude: *uses the review skill from docs-team-standards*
|
|
1046
936
|
|
|
1047
937
|
Terminology Review
|
|
1048
938
|
==========================================
|
|
@@ -1070,7 +960,7 @@ Summary:
|
|
|
1070
960
|
----
|
|
1071
961
|
You: Write a getting started guide for deploying a 3-node Redpanda cluster
|
|
1072
962
|
|
|
1073
|
-
Claude: *uses
|
|
963
|
+
Claude: *uses the page-templates skill from docs-team-standards*
|
|
1074
964
|
*applies team templates and standards*
|
|
1075
965
|
|
|
1076
966
|
= Deploy a Three-Node Redpanda Cluster
|
|
@@ -1103,7 +993,7 @@ You: This explanation of compaction is too complex. Can you simplify it?
|
|
|
1103
993
|
|
|
1104
994
|
[Paste complex explanation]
|
|
1105
995
|
|
|
1106
|
-
Claude: *uses
|
|
996
|
+
Claude: *uses the review skill from docs-team-standards*
|
|
1107
997
|
|
|
1108
998
|
Here's a clearer version:
|
|
1109
999
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redpanda-data/docs-extensions-and-macros",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.56.0",
|
|
4
4
|
"description": "Antora extensions and macros developed for Redpanda documentation.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"antora",
|
|
@@ -33,6 +33,7 @@
|
|
|
33
33
|
"test:cgo": "node __tests__/tools/cgo-detection.test.js",
|
|
34
34
|
"test:all": "npm run test && npm run test:python && npm run test:cgo",
|
|
35
35
|
"eval:doc-strings": "node evals/doc-strings/run-evals.js",
|
|
36
|
+
"eval:doc-impact": "node evals/doc-strings/run-evals.js --doc-impact",
|
|
36
37
|
"generate:cli-docs": "node tools/generate-cli-docs.js",
|
|
37
38
|
"bundle:admin": "doc-tools generate bundle-openapi --surface admin",
|
|
38
39
|
"bundle:connect": "doc-tools generate bundle-openapi --surface connect",
|
|
@@ -94,7 +95,9 @@
|
|
|
94
95
|
"./extensions/property-page-index": "./extensions/property-page-index.js",
|
|
95
96
|
"./extensions/render-property-descriptions": "./extensions/render-property-descriptions.js",
|
|
96
97
|
"./extensions/kapa-source-groups": "./extensions/kapa-source-groups.js",
|
|
97
|
-
"./docs-data/kapa-source-groups.json": "./docs-data/kapa-source-groups.json"
|
|
98
|
+
"./docs-data/kapa-source-groups.json": "./docs-data/kapa-source-groups.json",
|
|
99
|
+
"./macros/iceberg-explorer": "./macros/iceberg-explorer.js",
|
|
100
|
+
"./macros/iceberg-explorer.js": "./macros/iceberg-explorer.js"
|
|
98
101
|
},
|
|
99
102
|
"files": [
|
|
100
103
|
"extensions",
|