Skip to content

Add Algolia search to the website #4165

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.

Sign up for GitHub

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

Jump to bottom
Closed
JoshuaKGoldberg opened this issue Nov 17, 2021 · 2 comments · Fixed by #4187
Closed

Add Algolia search to the website #4165

JoshuaKGoldberg opened this issue Nov 17, 2021 · 2 comments · Fixed by #4187
Assignees
@JoshuaKGoldberg
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Nov 17, 2021 •
edited
Loading

Splitting out of #4156 as this has been in the works for a while: we need a good docs search solution on the site. Algolia is high quality, free for our kind of open source site, and the de facto standard for Docusaurus.
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Nov 17, 2021
@JoshuaKGoldberg
Copy link
Member Author

Current status: I've started a request with the Algolia folks through their normal intake process. I've told their friendly onboarding person that we do indeed maintain typescript-eslint.io. ⌛

@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Nov 17, 2021
@JoshuaKGoldberg JoshuaKGoldberg added the external This issue is with another package, not typescript-eslint itself label Nov 17, 2021
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Nov 17, 2021
Closed
@JoshuaKGoldberg
Copy link
Member Author

The Algolia rep emailed back that we should be good to go! https://github.com/algolia/docsearch-configs/blob/master/configs/typescript-eslint.json

Their prefab suggestion (note that we'll use the Docusaurus plugin instead):

<!-- at the end of the HEAD -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@docsearch/css@alpha" />

<!-- at the end of the BODY -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@docsearch/js@alpha"></script>
<script type="text/javascript">
docsearch({
appId: 'BH4D9OD16A',
apiKey: '1ad6b47d4e742c4c0653877b5511c602',
indexName: 'typescript-eslint',
container: '### REPLACE ME ####',
searchParameters: { 'facetFilters': ["type:$TYPE"] },
debug: false // Set debug to true if you want to inspect the modal
});
</script>

@JoshuaKGoldberg JoshuaKGoldberg moved this from In Progress to Todo in Documentation Nov 19, 2021
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed external This issue is with another package, not typescript-eslint itself labels Nov 19, 2021
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Nov 19, 2021
Merged
3 tasks
Repository owner moved this from Todo to Done in Documentation Nov 23, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 24, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
No open projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: added Algolia search to website JoshuaKGoldberg/typescript-eslint
2 participants
@JoshuaKGoldberg @bradzacher