Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Update Algolia index on master merge #10032

Merged
merged 5 commits into from
May 16, 2024
Merged

feat: Update Algolia index on master merge #10032

merged 5 commits into from
May 16, 2024

Conversation

a-hariti
Copy link
Collaborator

@a-hariti a-hariti commented May 14, 2024

Introduce a script to index the static docs HTML files generated by Next.js into Algolia.

It's a migration from the Gatsby solution, which relied on the gatsby-plugin-algolia here

The record generation logic is reused as is, with two notable changes:

  1. We manually feed the HTML files to the record generation function
  2. We manually upload the records to Algolia

Required environment variables before the merge (repo secrets):

  • ALGOLIA_APP_ID=OOK48W9UCL
  • ALGOLIA_API_KEY: The write API key
  • ALGOLIA_INDEX_PREFIX: (sentry-), which will show up as sentry-docs (index name) on Algolia
  • NEXT_PUBLIC_ALGOLIA_APP_ID=OOK48W9UCL
  • NEXT_PUBLIC_ALGOLIA_SEARCH_KEY=ca98597f559459c216891b75989832f8

ALGOLIA_INDEX_PREFIX can be set to a different string until we make sure this works as expected before setting it to sentry-

Closes #9869
Closes #9876
Closes #9778
Closes #6978

Copy link

vercel bot commented May 14, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2024 1:12pm

Copy link
Contributor

@stephanie-anderson stephanie-anderson left a comment

Choose a reason for hiding this comment

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

👏👏👏

Copy link

codecov bot commented May 15, 2024

Bundle Report

Changes will increase total bundle size by 77 bytes ⬆️

Bundle name Size Change
sentry-docs-client 6.16MB 4 bytes ⬇️
sentry-docs-server 7.38MB 84 bytes ⬆️
sentry-docs-edge-server 458.69kB 3 bytes ⬇️

@a-hariti a-hariti enabled auto-merge (squash) May 16, 2024 13:05
@a-hariti a-hariti merged commit d046409 into master May 16, 2024
8 checks passed
@a-hariti a-hariti deleted the algolia-index branch May 16, 2024 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants