website icon indicating copy to clipboard operation
website copied to clipboard

[WIP] Align to Docsy theme

Open sftim opened this issue 1 year ago โ€ข 9 comments

Redo the custom theme to be closer to vanilla Docsy.

Here's a preview

Helps with issue https://github.com/kubernetes/website/issues/41171

/area web-development


This PR is too large to merge as-is.

/hold until it is small enough to be reviewable as a single change (eg size/XL or smaller)

I will carve off smaller PRs that are reviewable.

sftim avatar Oct 15 '24 17:10 sftim

Pull request preview available for checking

Built without sensitive environment variables

Name Link
Latest commit 3e511355baf1057d4f126d08dc952c1fff169148
Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67e54e28033413000876aaca
Deploy Preview https://deploy-preview-48363--kubernetes-io-main-staging.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.

netlify[bot] avatar Oct 15 '24 17:10 netlify[bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Once this PR has been reviewed and has the lgtm label, please ask for approval from sftim. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

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

k8s-ci-robot avatar Jan 12 '25 15:01 k8s-ci-robot

Hello @sftim

For the localization-specific aspect, I compared the English version and Korean version of "Concepts" page:

https://deploy-preview-48363--kubernetes-io-main-staging.netlify.app/docs/concepts/ image

https://deploy-preview-48363--kubernetes-io-main-staging.netlify.app/ko/docs/concepts/ image

And here are what I found:

In top navbar,

  • Korean alt texts (or the title of each page) of "๋ฌธ์„œ(Documentation)" and "๋ธ”๋กœ๊ทธ(Blog)" are displayed, which is not in English version. And it seems that this affects
    • the menu entries not positioned as intended
    • the top navbar thicker than original.
      • The "Search this site" input, "Edit this page" and "Create child page" links are hidden by the thick top navbar
    • other menu entries ("ํŒŒํŠธ๋„ˆ(Partners)", "์ปค๋ฎค๋‹ˆํ‹ฐ(Community)", "์‚ฌ๋ก€ ์—ฐ๊ตฌ(Case Studies)") not displayed
  • the order of menu entries are different in Korean and English version;
    • in English page: "Documentation" - "Blog" - "Training" - "Partners" - ... - [Version Selector] - [Language Selector]
    • in Korean page: "๋ฌธ์„œ(Documentation)" - "๊ต์œก(Training)" - "๋ธ”๋กœ๊ทธ(Blog)" - [Other entries missing] - [Version Selector] - [Language Selector]

And the feedback section is not translated.

These are the points I found.

PTAL. ๐Ÿ˜Š

jihoon-seo avatar Jan 31 '25 02:01 jihoon-seo

Thanks @jihoon-seo

For some of these, we are dependent on localizations to do front matter updates. For example the menu front matter item in https://github.com/kubernetes/website/blob/main/content/en/docs/home/_index.md?plain=1#L13 vs https://github.com/kubernetes/website/blob/main/content/ko/docs/home/_index.md?plain=1#L13

That will (should) fix the top menu. I'll try this myself and might send in a PR against Korean.

sftim avatar Jan 31 '25 09:01 sftim

Hey Tim, are you still planning to break this PR into smaller ones. I have been thinking that getting the alignment done first can make the 0.7 upgrade a bit easier.

In which case, I can help with the carving off into smaller PRs. Unless you already plan to do it of course.

SayakMukhopadhyay avatar Feb 03 '25 13:02 SayakMukhopadhyay

Hey Tim, are you still planning to break this PR into smaller ones. I have been thinking that getting the alignment done first can make the 0.7 upgrade a bit easier.

I already have one PRsplit from this and awaiting review; for example:

  • https://github.com/kubernetes/website/pull/48258

as well as others - see https://github.com/kubernetes/website/pulls/sftim - that I need to rebase before they're ready for reviews.

You're welcome to carve some more off. I'll follow up via Slack.

sftim avatar Feb 03 '25 13:02 sftim

Thanks, excellent work Tim!

For the localization-specific aspect, I compared the English version and Korean version of "Concepts" page: ...

Let me comment the Japanese version,

I'm not sure if this is a problem unique to Japanese, but it looks like the navbar no longer fits on the screen. Most of the other issues are the same as in Korean. If necessary, I can create a PR for the Japanese localization, Thanks!!

ref. https://deploy-preview-48363--kubernetes-io-main-staging.netlify.app/ja/docs/concepts/

Screenshot 2025-02-07 at 22 04 46

Okabe-Junya avatar Feb 07 '25 13:02 Okabe-Junya

PRs to fix the menus (for localizations) are welcome. Please send the pull request against main.

sftim avatar Feb 07 '25 13:02 sftim

Sharing a comment on #41171 about the menu display issue. ๐Ÿ™‚ (Korean localization)

https://github.com/kubernetes/website/issues/41171#issuecomment-2653045316

seokho-son avatar Feb 13 '25 02:02 seokho-son

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

k8s-ci-robot avatar Apr 17 '25 02:04 k8s-ci-robot

Superseded by PR https://github.com/kubernetes/website/pull/50665

/close

lmktfy avatar Apr 24 '25 22:04 lmktfy