Skip to content

Conversation

@lmktfy
Copy link
Member

@lmktfy lmktfy commented Nov 25, 2025

@k8s-ci-robot k8s-ci-robot added the area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes label Nov 25, 2025
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Nov 25, 2025

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Nov 25, 2025
@k8s-ci-robot k8s-ci-robot requested a review from tengqm November 25, 2025 21:59
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 25, 2025
@lmktfy lmktfy force-pushed the 20251125_docsy_0_7 branch from e757033 to 9ffe7f6 Compare November 25, 2025 22:00
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 25, 2025
# User interface configuration
[params.ui]
# Allow resizing the sidebar gutter
sidebar_resizable = true
Copy link
Member Author

Choose a reason for hiding this comment

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

It's now configurable (and we do want it on, I think).

@lmktfy
Copy link
Member Author

lmktfy commented Nov 25, 2025

Hmm, it previewed OK locally.

@lmktfy lmktfy marked this pull request as draft November 25, 2025 22:09
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 25, 2025
@lmktfy lmktfy force-pushed the 20251125_docsy_0_7 branch from 9ffe7f6 to b9441bb Compare November 25, 2025 22:19
@netlify
Copy link

netlify bot commented Nov 25, 2025

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 0c54df3
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6928895d7d2ae0000875bff2
😎 Deploy Preview https://deploy-preview-53454--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 project configuration.

@lmktfy lmktfy marked this pull request as ready for review November 25, 2025 23:01
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 25, 2025
@lmktfy
Copy link
Member Author

lmktfy commented Nov 25, 2025

Turns out, it looks great, but the right-hand sidebar is missing.

@lmktfy lmktfy marked this pull request as draft November 25, 2025 23:05
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 25, 2025
@lmktfy lmktfy force-pushed the 20251125_docsy_0_7 branch 2 times, most recently from 5bc4937 to ac4ee32 Compare November 26, 2025 17:04
@lmktfy lmktfy marked this pull request as ready for review November 26, 2025 17:05
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 26, 2025
@lmktfy
Copy link
Member Author

lmktfy commented Nov 26, 2025

I prepared a backport to the v1.33 docs.

If we time this well, we can have the docs for v1.33, v1.34 and v1.35 all using the same Docsy theme, near as. That will help with usability.

@Andygol
Copy link
Contributor

Andygol commented Nov 27, 2025

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 27, 2025
@SayakMukhopadhyay
Copy link
Member

Turns out, it looks great, but the right-hand sidebar is missing.

This is a blocker for this PR right? I will take a look at this to figure out what's going wrong.

Copy link
Member

@dipesh-rawat dipesh-rawat left a comment

Choose a reason for hiding this comment

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

Some great work here! I’ve browsed through the preview site and noticed a few areas that might need attention.

My main concern is that the live docs website is referenced in the Kubernetes certification exam, so we need to ensure usability and consistency.

Below are the observations (verified on macOS using Chrome, Firefox and Safari):

  • Navbar layout has extra space on the left and might need alignment adjustments.
issue-1
  • There is a slight overflow or scroll on the left side of the site.
issue-2
  • In the footer, Bluesky and X social icons seem missing, and the Bluesky icon is not rendering on the blog index page.
issue-3 issue-3-1
  • Meta-links on the right has slight odd spacing (looks like the Print section seems to have its own id which is adding the padding).
issue-4
  • The Table of Contents on the right-hand side is missing.
issue-5
  • Feedback buttons appear to be gone. Was this intentional?
    (From the live site)
issue-6
  • Auto-generated reference pages are missing the banner at the end.
    (From the live site)
issue-7
  • Mobile view for auto-generated reference pages appears broken.
issue-8

Q) Are we confident the upgrade will work as expected when the site banner (upcoming KubeCon) is displayed?

@lmktfy
Copy link
Member Author

lmktfy commented Nov 27, 2025

Great stuff. I really appreciate the feedback.

/lgtm cancel
This isn't yet good enough to merge.

Here's what I would and wouldn't personally accept as a regression. In other words, these are my opinions. Anyway, here goes:

  • Bluesky icon
    accept - we can fix that as a fast-follow thing, and if it's wrong people will be motivated to intervene. Exam candidates should not be using Bluesky, of course.
    Maybe an even newer Docsy supports the Bluesky icon properly.

  • Tabs
    block until fixed - we need working tabs

  • Autogenerated pages, mobile view
    block until we have these at least good enough

  • Table of contents
    block until fixed - we need the right hand of the page to show a TOC

  • Automatically generated page banner
    accept; when we merge, file an issue about reinstating it.

  • Docsy 0.7 style navigation bar
    accept
    (only relevant in desktop view; mobile has one or two hamburger menus)
    I see that as a feature more than a bug. Is it important that we keep the top menu looking like it did before?

  • Kubernetes logo wrong in print version
    accept; when we merge, file an issue about addressing it.

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 27, 2025
@k8s-ci-robot k8s-ci-robot requested a review from Andygol November 27, 2025 17:17
@lmktfy lmktfy force-pushed the 20251125_docsy_0_7 branch from ac4ee32 to 0c54df3 Compare November 27, 2025 17:24
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Nov 27, 2025
@k8s-ci-robot
Copy link
Contributor

[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 assign dipesh-rawat for approval. 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

@lmktfy
Copy link
Member Author

lmktfy commented Nov 27, 2025

Folks, if you're willing to re-review, this might be good to go.

But if you spot a release blocker, that's super helpful. We don't want to break the UX enough that we'd need to revert.

@lmktfy lmktfy marked this pull request as draft November 27, 2025 17:34
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 27, 2025
@lmktfy lmktfy marked this pull request as ready for review November 27, 2025 17:35
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 27, 2025
@lmktfy
Copy link
Member Author

lmktfy commented Nov 27, 2025

There is a slight overflow or scroll on the left side of the site.

I couldn't reproduce this, BTW.

@lmktfy
Copy link
Member Author

lmktfy commented Nov 27, 2025

Things I think are fixed:

  1. Tabs
    They work now!
  2. Autogenerated pages, mobile view
    They seem fine.
  3. In the right-hand nav part of a page, you see a table of contents unless it is disabled for that page.

I haven't tested site banners post-upgrade. We don't have an imminent KubeCon or other major event and could work separately, after the merge of this PR, to assure that they work OK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Upgrade to Docsy 0.7.x from 0.6.0

5 participants