PageFind for users in China

[cjyabraham]

First, this PR has PageFind search available for all users OUTSIDE of China. This is just temporary to facilitate testing and we will revert this before merging the PR. The goal is to show PageFind to all users IN China, as a replacement for Bing, which has been costing CNCF a lot of money recently.

Could someone help integrate this into the Makefile properly. I’m not sure where it should be applied and how to integrate it. You can see what I’ve done to get PageFind to run in the netlify.toml commands but that may not be the right place for them.

Searches with PageFind can be compared against the current site. If they are adequate, then we can get this deployed soon to remove Bing from the site. We should specifically test searches in Chinese but also test English and other languages.

We can enhance the PageFind search functionality in the future with filters, sorting, etc. If the PageFind results become better than those of Google Custom Search, we can have it serve all users, not just those in China.

I pulled ideas from #44655 when creating this PR but started from scratch as I couldn’t get that PR branch to run locally. I also kept the scope narrower and less ambitious, limiting PageFind search to just Chinese users while keeping Google Custom Search for everyone else. This was so that we could address the immediate need of getting off Bing as quickly as possible.

FYI this is the command I use to test this locally:

hugo && npx -y pagefind --site public --serve

[netlify]

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	a4191d9
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66856231fa04520008c48716
😎 Deploy Preview	https://deploy-preview-46768--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[sftim]

Hi @cjyabraham

If I go to https://deploy-preview-46768--kubernetes-io-main-staging.netlify.app/zh-cn/docs/home/ and search for kubectl 命令行工具, I get pages in English. To be fair, I'm using a browser that prefers English but I was looking at the Chinese docs. This may well surprise users.

https://deploy-preview-46768--kubernetes-io-main-staging.netlify.app/search/?q=kubectl%20%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7

[sftim]

this PR has PageFind search available for all users OUTSIDE of China. This is just temporary to facilitate testing and we will revert this before merging the PR. The goal is to show PageFind to all users IN China, as a replacement for Bing, which has been #44475.

/hold
until this PR only shows PageFind to visitors from China

[cjyabraham]

If I go to https://deploy-preview-46768--kubernetes-io-main-staging.netlify.app/zh-cn/docs/home/ and search for kubectl 命令行工具, I get pages in English. To be fair, I'm using a browser that prefers English but I was looking at the Chinese docs. This may well surprise users.

It looks like this is due to a problem with how the site currently works: if you're viewing Chinese pages and then perform a search, you always get redirected to the English search results page instead of staying on the Chinese search results page. I think once we fix this then the results will be pulled correctly from the Chinese content rather than the English. You can see how that should look on the Chinese search results page here: https://deploy-preview-46768--kubernetes-io-main-staging.netlify.app/zh-cn/search/?q=kubectl+%E5%91%BD%E4%BB%A4%E8%A1%8C%E5%B7%A5%E5%85%B7

[cjyabraham]

Actually now that I think of it, it's a known issue with doscy which I have already submitted a fix for in this PR. Since that's not merged yet, we can reapply the fix locally within this site...

[cjyabraham]

Ok, I've fixed that issue so now the site should correctly keep the user on the search page of the same language they were on. This is going to be a problem, however, for languages that don't have search pages, like French, so perhaps we should quickly add content files for them?

UPDATE: I've added the missing search.md content files.

[pacoxu]

/cc @windsonsea @tengqm

[cjyabraham]

Can we have this PR reviewed please @kubernetes/sig-docs-leads

[nate-double-u]

I've pinged folks in the Kubernetes Slack channels #sig-docs, #sig-docs-localizations, and #kubernetes-docs-zh to see if they can help review.

[tengqm]

/lgtm

[k8s-ci-robot]

LGTM label has been added.

Details

Git tree hash: 94a5396c84752be78dcfc3bac4070a0b1d52dff1

[sftim]

/hold

This is also serving PageFind to users outside of China

[cjyabraham]

@sftim it seems that your rebase operation removed my last commit. Could you undo that?

[ydFu]

/lgtm

[sftim]

I'll update this PR when I get a moment.

[sftim]

/hold cancel

[sftim]

The PageFind functionality is only visible to users in China. However, you can check this out locally and try it by editing the search.js file; see https://github.com/kubernetes/website/compare/c86a1576dedaa56d1fce1ef0cbb7dda149477ba2..a4191d94ea52f8c4935c144f0d89d779b16f5812

[natalisucks]

/hold

@kubernetes/steering-committee howdy steering! this change has come about out of the CNCF's need to replace Bing for users in China, and our zh-localization community, alongside other folks in SIG Docs, have reviewed this change to ensure it's doing what it describes. we want to check if this needs to be run by you before merging – thanks!

[mrbobbytables]

LGTM on my side, I don't think it needs steering sign off 👍

[BenTheElder]

#46768 (comment) Agree.

[BenTheElder]

Feel free to unhold, or wait for a simple majority of steering (routine business rules would apply if a vote were needed for something like this), but I pretty strongly think this does not need to wait for steering and is delegated to SIG Docs.

(re: delegation, maybe reach out to SIG K8s Infra if we have new paid SaaS accounts to manage but AFAICT this is not the case here and still wouldn't involve steering)

[natalisucks]

sick, thanks @mrbobbytables and @BenTheElder!
/hold cancel
/lgtm

[k8s-ci-robot]

LGTM label has been added.

Details

Git tree hash: 82c0ff4334fe8c9154b587542f3f9e454d0861fc

[nate-double-u]

Thanks for this @cjyabraham & @sftim, and thanks to all the reviewers!

/approve

[sftim]

/lgtm

[sftim]

/assign natalisucks

[natalisucks]

/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: natalisucks, nate-double-u

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [natalisucks]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[SayakMukhopadhyay]

Hey @cjyabraham , I am working on aligning the search closer to Docsy as per #41171 and I wanted to understand the reasoning behind deleting the search from the sidebar for pagefind.

I do notice that the default search bar in the search results page is replace by the pagefind searchbar. Is this piece of code meant for removing the search bar in the search results?

[sftim]

Pagefind provides incremental search results in the same page, so there's no need to use a form that submits to a different page.

[SayakMukhopadhyay]

I was wondering why the .td-sidebar__search class was used to find the element. Cause its now having some side effects in #49724. The search in the sidebar of docs/blogs page don't show up in that PR for pagefind users. This is because the search in the sidebar uses the same class.

I did some check and it seems a change I did in that PR caused the search bar in the search results no longer have the .td-sidebar__search class. Anyway, thanks for jumping in @sftim , I will push a commit in that PR to fix it for pagefind users.