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

Swap in PageFind in place of Google Custom Search #624

Merged
merged 8 commits into from
Apr 15, 2024
Merged

Conversation

cjyabraham
Copy link
Contributor

@cjyabraham cjyabraham commented Mar 25, 2024

From cncf/cncf.io#836:

GCS 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.

In addition to installing PageFind, this PR changes the packaging and build of the site to be consistent with other CNCF subsites. It simplifies the build and removes the dependency on mage, go and docker. Also, it was the only way I could figure out how to get the site to work with PageFind. (Let me know if there are any objections to this change.) I've updated the instructions for how to run the site locally.

Signed-off-by: Chris Abraham <cjyabraham@gmail.com>
Signed-off-by: Chris Abraham <cjyabraham@gmail.com>
Signed-off-by: Chris Abraham <cjyabraham@gmail.com>
Signed-off-by: Chris Abraham <cjyabraham@gmail.com>
Signed-off-by: Chris Abraham <cjyabraham@gmail.com>
Signed-off-by: Chris Abraham <cjyabraham@gmail.com>
@cjyabraham cjyabraham marked this pull request as ready for review March 29, 2024 09:02
@cjyabraham cjyabraham requested a review from aliok March 29, 2024 09:02
@aliok
Copy link
Member

aliok commented Mar 29, 2024

@cjyabraham

I am good with the PageFind changes. However

It simplifies the build and removes the dependency on mage, go and docker.

I like Mage and Docker setup as it enables people to test with the exact same version of Hugo.

For example, I have 0.11x of Hugo locally, but another person has 0.12x. Container build is helping with that consistency. It also helps as I manage various Hugo websites which use different versions of Hugo.

I am not a big fan of Mage, but containered build is nice.

What do you think?

@cjyabraham
Copy link
Contributor Author

@aliok

Ok. I personally don't have much experience with Docker. Would you be able to adapt what I've got here to use it?

I'm basically trying to standardize the way all these CNCF subsites are built while also getting PageFind to work. I don't know of us ever having a problem in the past with different Hugo versions but we can use Docker if you think it's needed.

Signed-off-by: Chris Abraham <cjyabraham@gmail.com>
@cjyabraham
Copy link
Contributor Author

cjyabraham commented Apr 7, 2024

Any thoughts on this @aliok? Just to note, none of our other subsites (listed here) use docker in their build process. I don't get the sense that we're doing anything with Hugo that would produce different behavior under different versions.

@aliok
Copy link
Member

aliok commented Apr 15, 2024

@cjyabraham sorry I was on PTO last week and I will be unavailable this week for a business trip. I don't want to block this PR.

Let's merge and if Docker builds are really really needed, I can add support for that later on.

@cjyabraham cjyabraham merged commit 7d8764b into main Apr 15, 2024
2 checks passed
@cjyabraham cjyabraham deleted the pagefind branch April 15, 2024 07:12
@cjyabraham
Copy link
Contributor Author

Sounds good @aliok . Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants