@redpanda-data/docs-extensions-and-macros 4.4.0 → 4.4.2

package/bin/doc-tools.js

@@ -5,6 +5,20 @@ const { Command } = require('commander');
 const path = require('path');
 const fs = require('fs');
 
+function findRepoRoot(start = process.cwd()) {
+  let dir = start;
+  while (dir !== path.parse(dir).root) {
+    // marker could be a .git folder or package.json or anything you choose
+    if (fs.existsSync(path.join(dir, '.git')) ||
+        fs.existsSync(path.join(dir, 'package.json'))) {
+      return dir;
+    }
+    dir = path.dirname(dir);
+  }
+  console.error('❌ Could not find repo root (no .git or package.json in any parent)');
+  process.exit(1);
+}
+
 // --------------------------------------------------------------------
 // Dependency check functions
 // --------------------------------------------------------------------
@@ -107,7 +121,7 @@ const programCli = new Command();
 programCli
   .name('doc-tools')
   .description('Redpanda Document Automation CLI')
-  .version('1.0.0');
+  .version('1.0.1');
 
 // Top-level commands.
 programCli
@@ -295,6 +309,42 @@ automation
     process.exit(0);
   });
 
+  programCli
+  .command('link-readme')
+  .description('Symlink a README.adoc into docs/modules/<module>/pages/')
+  .requiredOption('-s, --subdir <subdir>', 'Relative path to the lab project subdirectory')
+  .requiredOption('-t, --target <filename>', 'Name of the target AsciiDoc file in pages/')
+  .action((options) => {
+    const repoRoot = findRepoRoot();
+    const normalized = options.subdir.replace(/\/+$/, '');
+    const moduleName = normalized.split('/')[0];
+
+    const projectDir = path.join(repoRoot, normalized);
+    const pagesDir   = path.join(repoRoot, 'docs', 'modules', moduleName, 'pages');
+    const sourceFile = path.join(projectDir, 'README.adoc');
+    const destLink   = path.join(pagesDir, options.target);
+
+    if (!fs.existsSync(projectDir)) {
+      console.error(`❌ Project directory not found: ${projectDir}`);
+      process.exit(1);
+    }
+    if (!fs.existsSync(sourceFile)) {
+      console.error(`❌ README.adoc not found in ${projectDir}`);
+      process.exit(1);
+    }
+
+    fs.mkdirSync(pagesDir, { recursive: true });
+    const relPath = path.relative(pagesDir, sourceFile);
+
+    try {
+      fs.symlinkSync(relPath, destLink);
+      console.log(`✔️  Linked ${relPath} → ${destLink}`);
+    } catch (err) {
+      console.error(`❌ Failed to create symlink: ${err.message}`);
+      process.exit(1);
+    }
+  });
+
 programCli
 .command('fetch')
 .description('Fetch a file or directory from GitHub and save locally')

package/extensions/replace-attributes-in-attachments.js

@@ -182,7 +182,7 @@ function getDynamicReplacements(componentVersion, logger) {
   const versionNum = formatVersion(componentVersion.version || '', semver);
   const is24_3plus =
     versionNum && semver.gte(versionNum, '24.3.0') && componentVersion.title === 'Self-Managed';
-  const useTagAttributes = isPrerelease || is24_3plus;
+  const useTagAttributes = isPrerelease || is24_3plus || componentVersion.title === 'Labs';
 
   // Derive Redpanda / Console versions
   const redpandaVersion = isPrerelease

package/macros/data-template.js

@@ -22,8 +22,8 @@ const jsonpath = require('jsonpath-plus');
 const yaml = require('yaml');
 // For synchronous HTTP fetching.
 const request = require('sync-request');
-const computeOut = require('../extension-utils/compute-out.js');
-const createAsciiDocFile = require('../extension-utils/create-asciidoc-file.js');
+const computeOut = require('../extensions/util/compute-out.js');
+const createAsciiDocFile = require('../extensions/util/create-asciidoc-file.js');
 
 // In-memory cache for external resources (avoid repeated network calls)
 const externalCache = new Map();

package/package.json

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