getsentry / sentry-docs

Sentry's documentation (and tools to build it)
https://docs.sentry.io
Other
319 stars 1.35k forks source link

feat: Update Algolia index on master merge #10032

Closed a-hariti closed 2 weeks ago

a-hariti commented 2 weeks ago

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_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

vercel[bot] commented 2 weeks ago

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
codecov[bot] commented 2 weeks ago

Bundle Report

Changes will increase total bundle size by 77 bytes :arrow_up:

Bundle name Size Change
sentry-docs-client 6.16MB 4 bytes :arrow_down:
sentry-docs-server 7.38MB 84 bytes :arrow_up:
sentry-docs-edge-server 458.69kB 3 bytes :arrow_down: