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

Use PageFind for search #3008

Merged
merged 6 commits into from
Mar 25, 2024
Merged

Use PageFind for search #3008

merged 6 commits into from
Mar 25, 2024

Conversation

cjyabraham
Copy link
Contributor

@cjyabraham cjyabraham commented Mar 24, 2024

From cncf/cncf.io#836:

Google Custom Search doesn't seem to produce very good search results on small sites. It'd be better to remove our reliance on Google as well. Instead we can use PageFind, which is an open source local search for static sites.

Current issues with GCS on the subsites:

Please test this to see if the search results are useful, complete and that it handles multiple languages effectively.

Copy link

netlify bot commented Mar 24, 2024

Deploy Preview for cncfglossary ready!

Name Link
🔨 Latest commit a2de621
🔍 Latest deploy log https://app.netlify.com/sites/cncfglossary/deploys/6601319d7b7836000814a6e2
😎 Deploy Preview https://deploy-preview-3008--cncfglossary.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
Collaborator

@jihoon-seo jihoon-seo left a comment

Choose a reason for hiding this comment

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

LGTM!
One thing that I want to mention is that

  • Currently, it seems that the Bengali, French, and Spanish versions of search.md file exist in main branch.
    image
  • The search feature for e.g., Korean is not working, since there is no Korean version of search.md file.
    (e.g., https://deploy-preview-3008--cncfglossary.netlify.app/ko/search/?q=kubernetes show 404 Not Found.)
  • To make the search feature working for all languages, each L10n team should localize search.md file and apply it to main branch.

@jihoon-seo jihoon-seo added the maintainers Use this label if PR requires maintainers to take action label Mar 25, 2024
@cjyabraham
Copy link
Contributor Author

Thanks @jihoon-seo , I've dropped in search.md files in each of the translation directories ready to be translated. At least now they won't get a 404 if they try and search.

Copy link
Collaborator

@bishal7679 bishal7679 left a comment

Choose a reason for hiding this comment

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

LGTM!
Is it visible for Hindi as well?

@cjyabraham
Copy link
Contributor Author

LGTM! Is it visible for Hindi as well?

yes

@seokho-son
Copy link
Collaborator

LGTM! Thanks @cjyabraham

I tested that the functionality works well.
If some strings in the search UI are not localized, I guess we can open a PR to the upstream PageFind

@seokho-son
Copy link
Collaborator

Let me merge this PR.

@seokho-son seokho-son merged commit 5787a9a into main Mar 25, 2024
6 checks passed
Copy link
Contributor

@justankiit justankiit left a comment

Choose a reason for hiding this comment

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

Lgtm!!

@cjyabraham cjyabraham deleted the pagefind branch March 25, 2024 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintainers Use this label if PR requires maintainers to take action
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants