@redpanda-data/docs-extensions-and-macros 3.0.4 → 3.0.6

package/extensions/algolia-indexer/generate-index.js

@@ -164,13 +164,13 @@ function generateIndex (playbook, contentCatalog, { indexLatestOnly = false, exc
     if (!(cname in algolia)) algolia[cname] = {}
     if (!(version in algolia[cname])) algolia[cname][version] = []
 
-    // Handle the article text
+    /* Handle the article text
     var text = decode(article.text)
     text = text.replace(/\n/g, ' ')
       .replace(/\r/g, ' ')
       .replace(/\s+/g, ' ')
       .trim()
-    if (text.length > 4000) text = text.substr(0, 4000)
+    if (text.length > 4000) text = text.substr(0, 4000)*/
 
     var tag = `${component.title}-${version}`
 
@@ -179,7 +179,7 @@ function generateIndex (playbook, contentCatalog, { indexLatestOnly = false, exc
       product: component.title,
       version: version,
       image: image? image: '',
-      text: text,
+      //text: text,
       breadcrumbs: breadcrumbs,
       intro: intro,
       objectID: urlPath + page.pub.url,

package/extensions/algolia-indexer/index.js

@@ -44,7 +44,11 @@ function register ({
       Object.keys(algolia[c]).forEach((v) => {
         algoliaCount += algolia[c][v].length
         // Save all records to the index
-        index.saveObjects(algolia[c][v]).wait();
+        index.saveObjects(algolia[c][v]).then(() => {
+          console.log(`${chalk.bold(algoliaCount)} Algolia index entries created`)
+        }).catch(error => {
+          console.error(`Error saving objects to Algolia: ${error}`);
+        });
         siteCatalog.addFile({
           mediaType: 'application/json',
           contents: Buffer.from(
@@ -62,7 +66,6 @@ function register ({
         'product'
       ]
     })
-    console.log(`${chalk.bold(algoliaCount)} Algolia index entries created`)
     // Get and print the count of all records in the index
     let recordCount = 0;
     index

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

@@ -8,8 +8,9 @@ module.exports.register = function ({ config }) {
     for (const { versions } of contentCatalog.getComponents()) {
       for (const { name: component, version, asciidoc } of versions) {
         const attachments = contentCatalog.findBy({ component, version, family });
+        if (component == 'api') continue
         for (const attachment of attachments) {
-          let contentString = String.fromCharCode(...attachment['_contents']);
+          let contentString = attachment['_contents'].toString('utf8');
           if (!asciidoc.attributes) continue
           if (!asciidoc.attributes.hasOwnProperty('replace-attributes-in-attachments')) continue;
           for (const key in asciidoc.attributes) {

package/extensions/version-fetcher/set-latest-version.js

@@ -15,49 +15,40 @@ module.exports.register = function ({ config }) {
     logger.warn('REDPANDA_GITHUB_TOKEN environment variable not set. Attempting unauthenticated request.');
   }
   this
-    .on('playbookBuilt', async ({ playbook }) => {
+    .on('contentClassified', async ({ contentCatalog }) => {
       try {
+        const LatestRedpandaVersion = await GetLatestRedpandaVersion();
         const LatestConsoleVersion = await GetLatestConsoleVersion();
-        if (!LatestConsoleVersion) {
-          logger.warn(`Failed to get latest Console version from GitHub`)
-          return
+        if (LatestRedpandaVersion.length !== 2 || !LatestRedpandaVersion[0]) {
+          logger.warn('Failed to get the latest Redpanda version - using defaults');
         }
-        if (!playbook.asciidoc) {
-          playbook.asciidoc = {};
-        }
-
-        if (!playbook.asciidoc.attributes) {
-          playbook.asciidoc.attributes = {};
+        if (!LatestConsoleVersion) {
+          logger.warn(`Failed to get latest Console version from GitHub - using default`)
         }
-        playbook.asciidoc.attributes['latest-console-version'] = LatestConsoleVersion
-        console.log(`${chalk.green('Set Redpanda Console version to')} ${chalk.bold(LatestConsoleVersion)}`);
-      } catch(error) {
-        logger.warn(error)
-      }
-    })
-    .on('contentClassified', async ({ contentCatalog }) => {
-      try {
-        const LatestRedpandaVersion = await GetLatestRedpandaVersion();
         const components = await contentCatalog.getComponents();
         for (let i = 0; i < components.length; i++) {
           let component = components[i];
-          if (LatestRedpandaVersion.length !== 2 || !LatestRedpandaVersion[0]) {
-            logger.warn('Failed to get the latest Redpanda versions - using defaults');
-            return
+          if (component.name !== 'ROOT' && component.name !== 'preview') continue
+
+          if (!component.latest.asciidoc) {
+            component.latest.asciidoc = {};
           }
-          if (component.name === 'ROOT') {
 
-            if (!component.latest.asciidoc) {
-              component.latest.asciidoc = {};
-            }
+          if (!component.latest.asciidoc.attributes) {
+            component.latest.asciidoc.attributes = {};
+          }
 
-            if (!component.latest.asciidoc.attributes) {
-              component.latest.asciidoc.attributes = {};
-            }
+          if (LatestRedpandaVersion.length !== 2 || !LatestRedpandaVersion[0]) continue;
 
-            component.latest.asciidoc.attributes['full-version'] = `${LatestRedpandaVersion[0]}`;
-            component.latest.asciidoc.attributes['latest-release-commit'] = `${LatestRedpandaVersion[1]}`;
-            console.log(`${chalk.green('Set Redpanda version to')} ${chalk.bold(LatestRedpandaVersion[0])} ${chalk.bold(LatestRedpandaVersion[1])}`)
+          component.latest.asciidoc.attributes['full-version'] = `${LatestRedpandaVersion[0]}`;
+          component.latest.asciidoc.attributes['latest-release-commit'] = `${LatestRedpandaVersion[1]}`;
+          console.log(`${chalk.green('Set Redpanda version to')} ${chalk.bold(LatestRedpandaVersion[0])} ${chalk.bold(LatestRedpandaVersion[1])}`)
+
+          if (LatestConsoleVersion) {
+            for (const { asciidoc } of component.versions) {
+              asciidoc.attributes['latest-console-version'] = `${LatestConsoleVersion}`;
+            }
+            console.log(`${chalk.green('Set Redpanda Console version to')} ${chalk.bold(LatestConsoleVersion)}`);
           }
         }
       } catch(error) {

package/macros/glossary.js

@@ -75,7 +75,7 @@ module.exports.register = function (registry, config = {}) {
     }
   }
 
-  //characters to replace by '_' in generated idprefix
+  //characters to replace by '-' in generated idprefix
   const IDRX = /[/ _.-]+/g
 
   function termId (term) {
@@ -123,9 +123,11 @@ module.exports.register = function (registry, config = {}) {
         var glossaryPage = document.getAttribute('glossary-page', '')
         if (glossaryPage.endsWith('.adoc')) {
           const page = config.contentCatalog.resolvePage(glossaryPage, config.file.src)
-          const relativizedPath = path.relative(path.dirname(config.file.pub.url), page.pub.url)
-          const prefix = attributes.prefix
-          glossaryPage = prefix ? [prefix, relativizedPath].join('/') : relativizedPath
+          if (page && config.config.attributes['site-url']) {
+            glossaryPage = config.config.attributes['site-url'] + page.pub.url
+          } else if (page) {
+            glossaryPage = path.relative(path.dirname(config.file.pub.url), page.pub.url)
+          }
         }
         const glossaryTermRole = document.getAttribute('glossary-term-role', 'glossary-term')
         const attrs = glossaryTermRole ? { role: glossaryTermRole } : {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "3.0.4",
+  "version": "3.0.6",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",
@@ -14,7 +14,7 @@
   },
   "scripts": {
     "build": "antora --to-dir docs --fetch local-antora-playbook.yml",
-    "serve": "wds --node-resolve --open preview/test.html --watch --root-dir docs"
+    "serve": "wds --node-resolve --open preview/test --watch --root-dir docs"
   },
   "contributors": [
     {