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: Updates the Algolia DocSearch eligibility description to match DocSearch page #9693

Merged
merged 1 commit into from
Jan 4, 2024

Conversation

ayip8
Copy link
Contributor

@ayip8 ayip8 commented Jan 3, 2024

Pre-flight checklist

Motivation

The previous documentation of the free Algolia DocSearch program only mentions open-source projects. At first this led me to believe I couldn't use it for our developer docs at Prefab (https://docs.prefab.cloud).

However, my understanding from reading https://docsearch.algolia.com/docs/who-can-apply/ is that DocSearch is free for all developer documentation, including commercial projects.

My change uses the same language as the above linked Algolia page for clarity and consistency.

Test Plan

N/A, this is only a documentation change.

Test links

Link to the changed page:
https://docusaurus.io/docs/search#using-algolia-docsearch

Related issues/PRs

N/A

The previous description was misleading. My understanding from reading https://docsearch.algolia.com/docs/who-can-apply/ is that DocSearch is free for all developer documentation, including commercial projects.
@ayip8 ayip8 requested a review from slorber as a code owner January 3, 2024 15:36
@facebook-github-bot
Copy link
Contributor

Hi @ayip8!

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@meta.com. Thanks!

Copy link

netlify bot commented Jan 3, 2024

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 02c2532
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/65957f0c540562000801c89d
😎 Deploy Preview https://deploy-preview-9693--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

github-actions bot commented Jan 3, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 72 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 89 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 77 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 75 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 65 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 75 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 78 🟢 100 🟢 100 🟢 90 🟠 89 Report

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 3, 2024
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Jan 4, 2024
@slorber
Copy link
Collaborator

slorber commented Jan 4, 2024

Thanks 👍 makes sense to keep the text consistent

@slorber slorber merged commit ece3d04 into facebook:main Jan 4, 2024
3 checks passed
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.

3 participants