Skip to content

Conversation

@jackw
Copy link
Collaborator

@jackw jackw commented Nov 28, 2025

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

@jackw jackw requested a review from a team as a code owner November 28, 2025 10:23
@jackw jackw added the type/docs Changes only affect the documentation label Nov 28, 2025
@jackw jackw requested a review from a team as a code owner November 28, 2025 10:23
Copilot AI review requested due to automatic review settings November 28, 2025 10:23
@jackw jackw added the no-changelog Don't include in changelog and version calculations label Nov 28, 2025
@jackw jackw marked this pull request as draft November 28, 2025 10:23
@github-actions
Copy link
Contributor

github-actions bot commented Nov 28, 2025

Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs.

run: npm run serve -w website -- --port 3000 &

- name: Wait for server
uses: grafana/plugin-actions/wait-for-grafana@wait-for-grafana/v1.0.2

Check warning

Code scanning / CodeQL

Unpinned tag for a non-immutable Action in workflow Medium

Unpinned 3rd party Action 'Deploy to Developer Portal DEV Bucket' step
Uses Step
uses 'grafana/plugin-actions/wait-for-grafana' with ref 'wait-for-grafana/v1.0.2', not a pinned commit hash
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This WIP pull request investigates replacing the current Lunr-based search with Algolia search for the Docusaurus documentation site. The changes include removing the docusaurus-lunr-search plugin, adding Algolia's search SDK, creating crawling scripts to generate search indices, and updating the configuration to use Algolia's DocSearch integration.

Key changes:

  • Replaces Lunr search with Algolia DocSearch integration
  • Adds crawling infrastructure using Crawlee to generate Algolia search indices
  • Updates environment configuration and deployment workflows for testing

Reviewed changes

Copilot reviewed 10 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
package-lock.json Updates dependencies: removes docusaurus-lunr-search, adds algoliasearch 5.45.0 and crawlee 3.15.3
docusaurus/website/package.json Adds algoliasearch and crawlee dependencies, removes docusaurus-lunr-search, adds generate-index script
docusaurus/website/docusaurus.config.ts Removes lunr-search plugin config, adds Algolia DocSearch configuration with environment variables
docusaurus/website/.env.production Adds Algolia environment variables (app ID, API key, index name)
docusaurus/website/.env.development Adds Algolia environment variables for development
docusaurus/website/scripts/algolia/crawl.ts New script to crawl documentation site and generate Algolia-formatted records
docusaurus/website/scripts/algolia/uploadToAlgolia.ts New script to upload records to Algolia index
docusaurus/website/scripts/algolia/types.ts TypeScript type definitions for Algolia DocSearch records
docusaurus/website/src/theme/tracking/index.ts Removes search tracking initialization
docusaurus/website/src/css/custom.css Comments out old search styles, adds Algolia DocSearch dark theme styles
.gitignore Adds storage directory to gitignore
.github/workflows/deploy-to-developer-portal-dev.yml Temporarily disables deployment, adds server startup for testing crawl script

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

const record = { objectID: 'object-1', name: 'test record' };

// Add record to an index
const { taskID } = await client.saveObject({
Copy link

Copilot AI Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused variable taskID.

Suggested change
const { taskID } = await client.saveObject({
await client.saveObject({

Copilot uses AI. Check for mistakes.
Comment on lines +90 to +102
const parsedUrl = new URL(request.url);
const basePath = '/developers/plugin-tools/';
let pathname = parsedUrl.pathname;

if (pathname.startsWith(basePath)) {
pathname = pathname.slice(basePath.length);
}

Copy link

Copilot AI Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The value assigned to pathname here is unused.

Suggested change
const parsedUrl = new URL(request.url);
const basePath = '/developers/plugin-tools/';
let pathname = parsedUrl.pathname;
if (pathname.startsWith(basePath)) {
pathname = pathname.slice(basePath.length);
}

Copilot uses AI. Check for mistakes.
@grafana-plugins-platform-bot grafana-plugins-platform-bot bot moved this from 📬 Triage to 🔬 In review in Plugins Platform / Grafana Community Nov 28, 2025
@hugohaggmark hugohaggmark removed their assignment Dec 5, 2025
@jackw jackw force-pushed the jackhugo/algolia-search branch from df704c4 to df9e674 Compare December 9, 2025 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation

Projects

Status: 🔬 In review

Development

Successfully merging this pull request may close these issues.

2 participants