[WIP] Align to Docsy theme #48363

sftim · 2024-10-15T17:19:46Z

Redo the custom theme to be closer to vanilla Docsy.

Here's a preview

Helps with issue #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.

netlify · 2024-10-15T17:27:28Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`3e51135`
🔍 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... Use your smartphone camera to open QR code link.

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

seokho-son · 2025-02-13T02:45:39Z

Sharing a comment on #41171 about the menu display issue. 🙂
(Korean localization)

#41171 (comment)

Copilot

Pull Request Overview

This PR updates the site's theme to more closely align with the vanilla Docsy theme while adding and adjusting search functionality and minor UI behaviors. Key changes include:

Introducing a new search script (search-google.js) for handling Google search.
Enhancing search.js with both Google and Pagefind search fallbacks plus additional DOM manipulations.
Modifying hugo.toml to update search-related configuration.
Adjusting banner dismissal behavior in banner-dismiss.js via a jQuery refactor.

Reviewed Changes

Copilot reviewed 74 out of 74 changed files in this pull request and generated 2 comments.

File	Description
assets/js/search-google.js	New search script added to support Google search integration.
assets/js/search.js	Refactored search behavior with added handling for fallback search methods.
hugo.toml	Updated configuration for search UI and theme parameters.
assets/js/banner-dismiss.js	Switched to jQuery methods for announcement dismissal with minor logic change.

Copilot · 2025-03-14T12:18:42Z

assets/js/search.js

+            sidebarSearch.remove();
+        }
+        document.getElementById('search').style.display = 'block';
+        pagefind = new PagefindUI({ element: "#search", showImages: false });


The 'pagefind' variable is assigned without declaration, which can lead to unintended global variable creation. Consider declaring it with 'let' or 'const'.

Suggested change

pagefind = new PagefindUI({ element: "#search", showImages: false });

let pagefind = new PagefindUI({ element: "#search", showImages: false });

@SayakMukhopadhyay FYI!

Nice find, I have updated #49724 with let or const as needed.

Copilot · 2025-03-14T12:18:43Z

assets/js/banner-dismiss.js

    }
    else {
-      announcement.classList.add('display-announcement') // Display the announcement if the cookie is not set
+      announcement.removeClass('announcement-shown').addClass('announcement-shown'); // Display the announcement if the cookie is not set


Removing and then immediately re-adding the same 'announcement-shown' class seems redundant; review the intended behavior for displaying the announcement.

Suggested change

announcement.removeClass('announcement-shown').addClass('announcement-shown'); // Display the announcement if the cookie is not set

announcement.addClass('announcement-shown'); // Display the announcement if the cookie is not set

I think the idea is to make sure the class is only asserted once. Not sure.

Redo the custom theme to be closer to vanilla Docsy.

k8s-ci-robot · 2025-04-17T02:27:26Z

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.

lmktfy · 2025-04-24T22:57:24Z

Superseded by PR #50665

/close

k8s-ci-robot requested review from natalisucks and salaxander October 15, 2024 17:19

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Oct 15, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch from e690c92 to ba2190e Compare October 19, 2024 10:25

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 19, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch from ba2190e to a6de947 Compare October 19, 2024 15:35

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 19, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch 4 times, most recently from c6f85e1 to 65a6340 Compare October 23, 2024 19:15

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 26, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch from 65a6340 to 1116c85 Compare October 26, 2024 20:29

k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Oct 26, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch from 1116c85 to ec2586b Compare October 27, 2024 15:32

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 27, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch from ec2586b to c6f85e1 Compare October 27, 2024 16:12

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 27, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch from c6f85e1 to ec2586b Compare October 27, 2024 16:20

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 27, 2024

sftim force-pushed the 20241015_align_style_to_docsy branch 2 times, most recently from b959c4c to 792471e Compare November 2, 2024 19:54

sftim mentioned this pull request Feb 12, 2025

Align with upstream Docsy #41171

Open

sftim force-pushed the 20241015_align_style_to_docsy branch from a63a2a2 to c05c31e Compare February 18, 2025 12:18

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 20, 2025

sftim force-pushed the 20241015_align_style_to_docsy branch from c05c31e to 38c3ffa Compare February 21, 2025 10:07

k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Feb 21, 2025

sftim force-pushed the 20241015_align_style_to_docsy branch from 38c3ffa to 0cf140d Compare February 25, 2025 20:25

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 25, 2025

sftim force-pushed the 20241015_align_style_to_docsy branch 2 times, most recently from 5bf5894 to 0c45173 Compare February 27, 2025 20:07

sftim requested a review from Copilot March 14, 2025 12:17

Copilot AI reviewed Mar 14, 2025

View reviewed changes

sftim force-pushed the 20241015_align_style_to_docsy branch from 0c45173 to 69d9bd0 Compare March 14, 2025 12:38

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 18, 2025

sftim force-pushed the 20241015_align_style_to_docsy branch from 69d9bd0 to b0d845d Compare March 22, 2025 16:04

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 22, 2025

This was referenced Mar 24, 2025

Reworking the sidebar in the blogs page #50157

Closed

Rework the navbar layouts and some navbar scripts to make it closer to docsy #50097

Merged

Use frontmatter menu information to generate the navbar menu instead of hardcoding #50228

Open

sftim force-pushed the 20241015_align_style_to_docsy branch from b0d845d to bf8fc73 Compare March 27, 2025 12:57

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 27, 2025

Align to Docsy theme

3e51135

Redo the custom theme to be closer to vanilla Docsy.

sftim force-pushed the 20241015_align_style_to_docsy branch from bf8fc73 to 3e51135 Compare March 27, 2025 13:09

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 27, 2025

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 17, 2025

lmktfy mentioned this pull request Apr 24, 2025

[WIP] Align to Docsy theme #50665

Draft

lmktfy closed this Apr 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[WIP] Align to Docsy theme #48363

[WIP] Align to Docsy theme #48363

Uh oh!

sftim commented Oct 15, 2024 •

edited

Loading

Uh oh!

netlify bot commented Oct 15, 2024 •

edited

Loading

Uh oh!

seokho-son commented Feb 13, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 14, 2025

Uh oh!

sftim Mar 14, 2025

Uh oh!

SayakMukhopadhyay Mar 14, 2025

Uh oh!

Copilot AI Mar 14, 2025

Uh oh!

sftim Mar 14, 2025

Uh oh!

k8s-ci-robot commented Apr 17, 2025

Uh oh!

lmktfy commented Apr 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

	pagefind = new PagefindUI({ element: "#search", showImages: false });
	let pagefind = new PagefindUI({ element: "#search", showImages: false });

	announcement.removeClass('announcement-shown').addClass('announcement-shown'); // Display the announcement if the cookie is not set
	announcement.addClass('announcement-shown'); // Display the announcement if the cookie is not set

[WIP] Align to Docsy theme #48363

[WIP] Align to Docsy theme #48363

Uh oh!

Conversation

sftim commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Oct 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Pull request preview available for checking

Uh oh!

seokho-son commented Feb 13, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

sftim Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

SayakMukhopadhyay Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

sftim Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Apr 17, 2025

Uh oh!

lmktfy commented Apr 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

sftim commented Oct 15, 2024 •

edited

Loading

netlify bot commented Oct 15, 2024 •

edited

Loading