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

Added Algolia's Jekyll plugin to build a search index #103

Open
wants to merge 2 commits into
base: algolia
Choose a base branch
from

Conversation

tomasff
Copy link
Contributor

@tomasff tomasff commented May 19, 2021

I've added Algolia's Jekyll plugin so that we could search through the entire notes posted on the website.

I've tested this in a fork of csrgg-home and it would look like this:
UI

I modified the current GH Actions to update the index when the site is built too, although I haven't been able to test the changes.

You'd need to setup an index in Algolia to get an API key and the other credentials. They have a free plan that should be enough (10k search results/month). We might be able to get more search results per month using Algolia for Open Source

This is related to this PR.

@tomasff
Copy link
Contributor Author

tomasff commented May 19, 2021

Oh also there's a demo of the searching thing here. It's also possible to add the search bar directly on the current home page.

@Justanhy
Copy link
Member

Justanhy commented May 20, 2021

Looks really good to me, we'll discuss about it abit and decide if we want to go with it.

For now, I've changed the base branch from master to a new one. If we go through with it we'll add the API Keys and test it before pushing it to master.

@Justanhy Justanhy added the enhancement New feature or request label May 20, 2021
@Justanhy Justanhy changed the base branch from master to algolia May 20, 2021 08:49
@leoriviera
Copy link
Collaborator

I've added Algolia's Jekyll plugin so that we could search through the entire notes posted on the website.

I've tested this in a fork of csrgg-home and it would look like this:

UI

I modified the current GH Actions to update the index when the site is built too, although I haven't been able to test the changes.

You'd need to setup an index in Algolia to get an API key and the other credentials. They have a free plan that should be enough (10k search results/month). We might be able to get more search results per month using Algolia for Open Source

This is related to this PR.

Thank you a lot for integrating this, Tomas! I'll look into Algolia for Open Source and work with @Justanhy to get those keys set up. Reading on their site, I don't think we'll qualify for AOS, but it won't hurt to apply and see what they say.

@EdmundGoodman
Copy link
Member

@all-contributors add @tomasff to design

@allcontributors

This comment has been minimized.

@CSRG-Group CSRG-Group deleted a comment from lchipchase May 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants