-
Notifications
You must be signed in to change notification settings - Fork 15.1k
Bump Docsy to 0.7.x #53454
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
base: main
Are you sure you want to change the base?
Bump Docsy to 0.7.x #53454
Conversation
e757033 to
9ffe7f6
Compare
| # User interface configuration | ||
| [params.ui] | ||
| # Allow resizing the sidebar gutter | ||
| sidebar_resizable = true |
There was a problem hiding this comment.
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).
|
Hmm, it previewed OK locally. |
9ffe7f6 to
b9441bb
Compare
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Turns out, it looks great, but the right-hand sidebar is missing. |
5bc4937 to
ac4ee32
Compare
|
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. |
|
/lgtm |
This is a blocker for this PR right? I will take a look at this to figure out what's going wrong. |
dipesh-rawat
left a comment
There was a problem hiding this 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.
- There is a slight overflow or scroll on the left side of the site.
- In the footer, Bluesky and X social icons seem missing, and the Bluesky icon is not rendering on the blog index page.
- 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).
- The Table of Contents on the right-hand side is missing.
- Feedback buttons appear to be gone. Was this intentional?
(From the live site)
- Auto-generated reference pages are missing the banner at the end.
(From the live site)
- Mobile view for auto-generated reference pages appears broken.
Q) Are we confident the upgrade will work as expected when the site banner (upcoming KubeCon) is displayed?
|
Great stuff. I really appreciate the feedback. /lgtm cancel Here's what I would and wouldn't personally accept as a regression. In other words, these are my opinions. Anyway, here goes:
|
Render them the same way as Docsy-native tabs.
ac4ee32 to
0c54df3
Compare
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
|
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. |
I couldn't reproduce this, BTW. |
|
Things I think are fixed:
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. |
This PR upgrades to a newer version of Docsy: 0.7.2
It is based on PR #48725
Here are some previews:
Relevant to issue #44002
/area web-development
Fixes #49430