@redpanda-data/docs-extensions-and-macros 3.5.7 → 3.5.9

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

@@ -203,7 +203,7 @@ function generateIndex (playbook, contentCatalog, { indexLatestOnly = false, exc
       indexItem.deployment = deployment;
       indexItem.type = 'Lab';
       indexItem.interactive = false;
-      indexItem._tags = ['labs'];
+      indexItem._tags = [tag];
     }
     algolia[cname][version].push(indexItem)
     algoliaCount++

package/extensions/find-related-labs.js

@@ -4,7 +4,7 @@ module.exports.register = function ({ config }) {
   const logger = this.getLogger('related-labs-extension');
 
   this.on('documentsConverted', async ({ contentCatalog, siteCatalog }) => {
-    const docs = contentCatalog.findBy({ component: 'ROOT', family: 'page' });
+    const docs = contentCatalog.findBy({ family: 'page' });
     docs.forEach((docPage) => {
       const relatedLabs = []
       const sourceAttributes = docPage.asciidoc.attributes
@@ -31,7 +31,7 @@ function findRelated(labPage, sourceCategoryList, sourceDeploymentType, logger)
   const targetCategoryList = pageCategories.split(',').map(c => c.trim());
   const targetDeploymentType = getDeploymentType(targetAttributes)
   const categoryMatch = hasMatchingCategory(sourceCategoryList, targetCategoryList)
-  if (categoryMatch && (!targetDeploymentType ||sourceDeploymentType === targetDeploymentType || targetDeploymentType === 'Docker')) {
+  if (categoryMatch && (!targetDeploymentType ||sourceDeploymentType === targetDeploymentType || (targetDeploymentType === 'Docker' && !sourceDeploymentType))) {
     return {
       title: labPage.asciidoc.doctitle,
       url: labPage.pub.url,
@@ -45,7 +45,8 @@ function getDeploymentType (attributes) {
   return attributes['env-kubernetes'] ? 'Kubernetes'
     : attributes['env-linux'] ? 'Linux'
       : attributes['env-docker'] ? 'Docker'
-        : attributes.cloud ? 'Redpanda Cloud' : ''
+        : attributes['env-cloud'] ? 'Redpanda Cloud'
+          : attributes['page-cloud'] ? 'Redpanda Cloud' : ''
 }
 
 function hasMatchingCategory (sourcePageCategories, targetPageCategories) {

package/extensions/version-fetcher/get-latest-connect.js

@@ -1,22 +1,21 @@
-// Fetch the latest release version from GitHub
-const { Octokit } = require("@octokit/rest");
-const { retry } = require("@octokit/plugin-retry");
-const OctokitWithRetries = Octokit.plugin(retry);
-const owner = 'redpanda-data';
-const repo = 'connect';
-
-let githubOptions = {
-  userAgent: 'Redpanda Docs',
-  baseUrl: 'https://api.github.com',
-};
+module.exports = async () => {
+  // Fetch the latest release version from GitHub
+  const { Octokit } = await import("@octokit/rest");
+  const { retry } = await import("@octokit/plugin-retry");
+  const OctokitWithRetries = Octokit.plugin(retry);
+  const owner = 'redpanda-data';
+  const repo = 'connect';
 
-if (process.env.REDPANDA_GITHUB_TOKEN) {
-  githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
-}
+  let githubOptions = {
+    userAgent: 'Redpanda Docs',
+    baseUrl: 'https://api.github.com',
+  };
 
-const github = new OctokitWithRetries(githubOptions);
+  if (process.env.REDPANDA_GITHUB_TOKEN) {
+    githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
+  }
 
-module.exports = async () => {
+  const github = new OctokitWithRetries(githubOptions);
   try {
     const release = await github.rest.repos.getLatestRelease({ owner, repo });
     tag = release.data.tag_name.replace(/^v/, '');

package/extensions/version-fetcher/get-latest-console-version.js

@@ -1,22 +1,22 @@
-const { Octokit } = require("@octokit/rest");
-const { retry } = require("@octokit/plugin-retry");
-const semver = require("semver");
-const OctokitWithRetries = Octokit.plugin(retry);
-const owner = 'redpanda-data';
-const repo = 'console';
+module.exports = async () => {
+  const { Octokit } = await import("@octokit/rest");
+  const { retry } = await import("@octokit/plugin-retry");
+  const semver = await import("semver");
+  const OctokitWithRetries = Octokit.plugin(retry);
+  const owner = 'redpanda-data';
+  const repo = 'console';
 
-let githubOptions = {
-  userAgent: 'Redpanda Docs',
-  baseUrl: 'https://api.github.com',
-};
+  let githubOptions = {
+    userAgent: 'Redpanda Docs',
+    baseUrl: 'https://api.github.com',
+  };
 
-if (process.env.REDPANDA_GITHUB_TOKEN) {
-  githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
-}
+  if (process.env.REDPANDA_GITHUB_TOKEN) {
+    githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
+  }
 
-const github = new OctokitWithRetries(githubOptions);
+  const github = new OctokitWithRetries(githubOptions);
 
-module.exports = async () => {
   try {
     const releases = await github.rest.repos.listReleases({
       owner,

package/extensions/version-fetcher/get-latest-operator-version.js

@@ -1,22 +1,21 @@
-// Fetch the latest release version from GitHub
-const { Octokit } = require("@octokit/rest");
-const { retry } = require("@octokit/plugin-retry");
-const OctokitWithRetries = Octokit.plugin(retry);
-const owner = 'redpanda-data';
-const repo = 'redpanda-operator';
-
-let githubOptions = {
-  userAgent: 'Redpanda Docs',
-  baseUrl: 'https://api.github.com',
-};
+module.exports = async () => {
+  // Fetch the latest release version from GitHub
+  const { Octokit } = await import("@octokit/rest");
+  const { retry } = await import("@octokit/plugin-retry");
+  const OctokitWithRetries = Octokit.plugin(retry);
+  const owner = 'redpanda-data';
+  const repo = 'redpanda-operator';
 
-if (process.env.REDPANDA_GITHUB_TOKEN) {
-  githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
-}
+  let githubOptions = {
+    userAgent: 'Redpanda Docs',
+    baseUrl: 'https://api.github.com',
+  };
 
-const github = new OctokitWithRetries(githubOptions);
+  if (process.env.REDPANDA_GITHUB_TOKEN) {
+    githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
+  }
 
-module.exports = async () => {
+  const github = new OctokitWithRetries(githubOptions);
   try {
     const release = await github.rest.repos.getLatestRelease({ owner, repo });
     latestOperatorReleaseVersion = release.data.tag_name;

package/extensions/version-fetcher/get-latest-redpanda-helm-version.js

@@ -1,20 +1,19 @@
-const { Octokit } = require("@octokit/rest");
-const { retry } = require("@octokit/plugin-retry");
-const yaml = require('js-yaml');
-const OctokitWithRetries = Octokit.plugin(retry);
-
-const githubOptions = {
-  userAgent: 'Redpanda Docs',
-  baseUrl: 'https://api.github.com',
-  auth: process.env.REDPANDA_GITHUB_TOKEN
-};
+module.exports = async () => {
+  const { Octokit } = await import("@octokit/rest");
+  const { retry } = await import("@octokit/plugin-retry");
+  const yaml = await import('js-yaml');
+  const OctokitWithRetries = Octokit.plugin(retry);
 
-const github = new OctokitWithRetries(githubOptions);
-const owner = 'redpanda-data';
-const repo = 'helm-charts';
-const path = 'charts/redpanda/Chart.yaml';
+  const githubOptions = {
+    userAgent: 'Redpanda Docs',
+    baseUrl: 'https://api.github.com',
+    auth: process.env.REDPANDA_GITHUB_TOKEN
+  };
 
-module.exports = async () => {
+  const github = new OctokitWithRetries(githubOptions);
+  const owner = 'redpanda-data';
+  const repo = 'helm-charts';
+  const path = 'charts/redpanda/Chart.yaml';
   try {
     const response = await github.repos.getContent({
       owner: owner,

package/extensions/version-fetcher/get-latest-redpanda-version.js

@@ -1,23 +1,22 @@
-const { Octokit } = require("@octokit/rest");
-const { retry } = require("@octokit/plugin-retry");
-const semver = require("semver");
-const OctokitWithRetries = Octokit.plugin(retry);
-
-const owner = 'redpanda-data';
-const repo = 'redpanda';
+module.exports = async () => {
+  const { Octokit } = await import("@octokit/rest");
+  const { retry } = await import("@octokit/plugin-retry");
+  const semver = await import("semver");
+  const OctokitWithRetries = Octokit.plugin(retry);
 
-let githubOptions = {
-  userAgent: 'Redpanda Docs',
-  baseUrl: 'https://api.github.com',
-};
+  const owner = 'redpanda-data';
+  const repo = 'redpanda';
 
-if (process.env.REDPANDA_GITHUB_TOKEN) {
-  githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
-}
+  let githubOptions = {
+    userAgent: 'Redpanda Docs',
+    baseUrl: 'https://api.github.com',
+  };
 
-const github = new OctokitWithRetries(githubOptions);
+  if (process.env.REDPANDA_GITHUB_TOKEN) {
+    githubOptions.auth = process.env.REDPANDA_GITHUB_TOKEN;
+  }
 
-module.exports = async () => {
+  const github = new OctokitWithRetries(githubOptions);
   try {
     // Fetch all the releases from the repository
     const releases = await github.rest.repos.listReleases({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redpanda-data/docs-extensions-and-macros",
-  "version": "3.5.7",
+  "version": "3.5.9",
   "description": "Antora extensions and macros developed for Redpanda documentation.",
   "keywords": [
     "antora",
@@ -57,8 +57,6 @@
     "url": "git+https://github.com/redpanda-data/docs-extensions-and-macros"
   },
   "dependencies": {
-    "@octokit/plugin-retry": "~4.1.3",
-    "@octokit/rest": "~19.0.7",
     "algoliasearch": "^4.17.0",
     "chalk": "4.1.2",
     "gulp": "^4.0.2",
@@ -72,6 +70,9 @@
   "devDependencies": {
     "@antora/cli": "3.1.4",
     "@antora/site-generator": "3.1.4",
+    "@octokit/core": "^6.1.2",
+    "@octokit/plugin-retry": "^7.1.1",
+    "@octokit/rest": "^21.0.1",
     "@web/dev-server": "^0.2.5"
   }
 }