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

docs(search): Algolia troubleshooting section for index configuration problems #10056

Merged
merged 3 commits into from
Apr 18, 2024

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Apr 18, 2024

Motivation

Many Docusaurus sites using Algolia DocSearch encounter index configuration problems.

This is a bit nasty because:

  • I think the Algolia team creates the initial crawler config and they may make mistakes
  • Docusaurus sites upgrade from v1 to v2/v3, with significant config changes
  • Changing the crawler config initialIndexSettings is not automatically applied to the index
  • It's easier to delete/recreate the index from scratch on config change

For that reason, let's write more information on our docs so that we receive fewer support requests on GitHub or Discord.

Related issues/PRs

#10050

#9200

#10007

... and many others

@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Apr 18, 2024
@slorber slorber requested a review from Josh-Cena as a code owner April 18, 2024 13:02
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 18, 2024
Copy link

netlify bot commented Apr 18, 2024

[V2]

Name Link
🔨 Latest commit 188fa85
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/66211ab934418300087b6965
😎 Deploy Preview https://deploy-preview-10056--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 67 🟢 98 🟢 96 🟢 100 🟠 88 Report
/docs/installation 🟠 64 🟢 96 🟢 100 🟢 100 🟠 88 Report
/docs/category/getting-started 🟠 74 🟢 100 🟢 100 🟢 90 🟠 88 Report
/blog 🟠 70 🟢 100 🟢 100 🟢 90 🟠 88 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 59 🟢 96 🟢 100 🟢 100 🟠 88 Report
/blog/tags/release 🟠 66 🟢 100 🟢 100 🟠 80 🟠 88 Report
/blog/tags 🟠 73 🟢 100 🟢 100 🟢 90 🟠 88 Report

Copy link

Size Change: 0 B

Total Size: 1.59 MB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/codeTranslations.json 2 B
website/.docusaurus/docusaurus.config.mjs 26.7 kB
website/.docusaurus/globalData.json 91.2 kB
website/.docusaurus/i18n.json 930 B
website/.docusaurus/registry.js 247 kB
website/.docusaurus/routes.js 156 kB
website/.docusaurus/routesChunkNames.json 109 kB
website/.docusaurus/site-metadata.json 2.17 kB
website/build/assets/css/styles.********.css 113 kB
website/build/assets/js/main.********.js 808 kB
website/build/index.html 38 kB

compressed-size-action

@slorber
Copy link
Collaborator Author

slorber commented Apr 18, 2024

Hey @shortcuts, will merge now, but feel free to review and submit a PR if you think any of this is incorrect

@slorber slorber merged commit 01ffcd9 into main Apr 18, 2024
11 checks passed
@slorber slorber deleted the slorber/algolia-troubleshooting branch April 18, 2024 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants