fix: Handle missing Algolia credentials in local development - Modified export-content-extension.js to gracefully skip Algolia indexing when credentials are missing - Added hasAlgoliaCredentials() function to check for required environment variables - Created scripts/dev-server.sh for simplified local development workflow - Resolves npm run start:dev failures due to missing ALGOLIA_APP_ID, ALGOLIA_ADMIN_KEY, and ALGOLIA_INDEX_NAME (#95)

Co-authored-by: joshassad1 <[email protected]>

Author: cci-jassad

extensions/export-content-extension.js

@@ -17,7 +17,7 @@ module.exports.register = function () {
     await fsPromises.writeFile(outPath, JSON.stringify({ pages }, null, 2));
     console.log(`Wrote JSON to ${outPath}`);
 
-    if (!shouldSkipIndexing() && !hasIndexed(tempDir)) {
+    if (!shouldSkipIndexing() && !hasIndexed(tempDir) && hasAlgoliaCredentials()) {
       try {
         await indexToAlgolia(pages);
         await fsPromises.writeFile(path.join(tempDir, 'algolia-indexed.marker'), new Date().toISOString());
@@ -26,7 +26,7 @@ module.exports.register = function () {
         console.error('Error indexing to Algolia:', err);
       }
     } else {
-      console.log('Skipping Algolia indexing');
+      console.log('Skipping Algolia indexing (missing credentials or already indexed)');
     }
   });
 };
@@ -94,6 +94,13 @@ function hasIndexed(dir) {
   return fs.existsSync(path.join(dir, 'algolia-indexed.marker'));
 }
 
+function hasAlgoliaCredentials() {
+  const appId = process.env.ALGOLIA_APP_ID;
+  const apiKey = process.env.ALGOLIA_ADMIN_KEY;
+  const indexName = process.env.ALGOLIA_INDEX_NAME;
+  return !!(appId && apiKey && indexName);
+}
+
 /**
  * Chunk pages into smaller records to meet Algolia's 10KB limit.
  */

scripts/dev-server.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+echo "Starting CircleCI Docs development server..."
+
+# Build the UI bundle
+echo "Building UI bundle..."
+npm run build:ui
+
+# Build the documentation site (without Algolia extension to avoid credential issues)
+echo "Building documentation..."
+npx antora antora-playbook.yml --extension ./extensions/page-metadata-extension.js
+
+# Start the development server
+echo "Starting development server on http://localhost:3000..."
+echo "Press Ctrl+C to stop the server"
+cd build && python3 -m http.server 3000