@redpanda-data/docs-extensions-and-macros 5.38.8 → 5.38.9

package/extensions/render-property-descriptions.js

@@ -261,11 +261,26 @@ function anchorIndex (contentCatalog, attachment, properties, logger) {
   }
   for (const [name, entry] of pages) {
     if (!entry || !entry.page) continue
-    index.set(propertyAnchor(name), { page: entry.page, name })
+    const anchor = propertyAnchor(name)
+    index.set(anchor, { page: entry.page, name, anchor })
+    // Legacy spelling. Before anchors replaced dots with hyphens they dropped
+    // them, so descriptions written then say <<redpandaremoteread>> for
+    // redpanda.remote.read, and some carry a stray hyphen (<<redpandastorage-mode>>).
+    // Those still name a documented property; only the spelling is old. Index
+    // the dot-and-hyphen-free form too, so they resolve to the real anchor
+    // instead of degrading to plain text and a warning on every build of every
+    // version still carrying them. A real anchor always wins over a legacy one.
+    const legacy = LEGACY_ANCHOR_PREFIX + legacyAnchorKey(name)
+    if (!index.has(legacy)) index.set(legacy, { page: entry.page, name, anchor })
   }
   return index
 }
 
+const LEGACY_ANCHOR_PREFIX = 'legacy:'
+function legacyAnchorKey (name) {
+  return name.replace(/[.-]/g, '')
+}
+
 /**
  * Rewrite <<anchor>> to an xref before conversion.
  *
@@ -278,8 +293,8 @@ function anchorIndex (contentCatalog, attachment, properties, logger) {
 function resolveInternalRefs (description, anchors, report) {
   return description.replace(INTERNAL_REF_RX, (match, anchor, display) => {
     const text = (display || '').trim()
-    const target = anchors.get(anchor)
-    if (target) return `xref:reference:${target.page}.adoc#${anchor}[${attrlistValue(text || `\`${target.name}\``)}]`
+    const target = anchors.get(anchor) || anchors.get(LEGACY_ANCHOR_PREFIX + legacyAnchorKey(anchor))
+    if (target) return `xref:reference:${target.page}.adoc#${target.anchor || anchor}[${attrlistValue(text || `\`${target.name}\``)}]`
     // The anchor names no documented property, so there is nothing to link to.
     // Asciidoctor would render a same-page fragment, and a tooltip is shown on
     // arbitrary pages, so that link would go nowhere and still invite a click --

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "5.38.8",
+  "version": "5.38.9",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",