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: improve algolia integration instructions #6008

Merged
merged 3 commits into from
Nov 25, 2021
Merged

Conversation

shafy
Copy link
Contributor

@shafy shafy commented Nov 25, 2021

Motivation

The current version makes it look like you need to install @docusaurus/theme-search-algolia on top the classic version to work, but it already works with the classic version. Adding @docusaurus/theme-search-algolia on top leads to errors.

The current version makes it look like you need to install `@docusaurus/theme-search-algolia` on top the classic version to work, but it already works with the classic version. Adding `@docusaurus/theme-search-algolia` on top leads to errors.
@facebook-github-bot
Copy link
Contributor

Hi @shafy!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@netlify
Copy link

netlify bot commented Nov 25, 2021

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 9062560

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/619f7a023001de000741eb97

😎 Browse the preview: https://deploy-preview-6008--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Nov 25, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟢 Performance 93
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-6008--docusaurus-2.netlify.app/

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 25, 2021
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Thanks, made some changes because not all users use the classic preset (especially into the future), and indeed the installation has caused confusions (typescript-eslint/typescript-eslint#4187 (comment)), so made it more explicit

@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Nov 25, 2021
@Josh-Cena Josh-Cena merged commit 8359ff3 into facebook:main Nov 25, 2021
@shafy
Copy link
Contributor Author

shafy commented Nov 25, 2021

Awesome, thanks @Josh-Cena

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.

None yet

3 participants