Skip to content
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

Upgrade to Docsy 0.5.1 via NPM module (1.31 backport) #49031

Merged

Conversation

sftim
Copy link
Contributor

@sftim sftim commented Dec 12, 2024

Based on PR #48812 by @chalin

Upgrade the v1.31 docs to use Docsy 0.5.1

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. area/web-development Issues or PRs related to the kubernetes.io's infrastructure, design, or build processes labels Dec 12, 2024
@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 12, 2024
Copy link

netlify bot commented Dec 12, 2024

Deploy Preview for k8s-v1-31 ready!

Name Link
🔨 Latest commit 89896bc
🔍 Latest deploy log https://app.netlify.com/sites/k8s-v1-31/deploys/678e782ef48d4700078f0372
😎 Deploy Preview https://deploy-preview-49031--k8s-v1-31.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.

@sftim
Copy link
Contributor Author

sftim commented Dec 12, 2024

/hold
for PR #48812 to merge

/area web-development

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 12, 2024
Copy link

netlify bot commented Dec 12, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 89896bc
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/678e782e8548850008c1248e
😎 Deploy Preview https://deploy-preview-49031--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.

sftim and others added 3 commits December 12, 2024 02:29
Adapt the existing page to work with (near-)vanilla Docsy.

This includes new localizable strings.
Put legacy and current styles in one place, and simplify CSS load.
@sftim
Copy link
Contributor Author

sftim commented Dec 12, 2024

Hmm. https://deploy-preview-49031--k8s-v1-31.netlify.app/community/ looks wrong and I cannot figure out why.

/retitle [WIP] Upgrade to Docsy 0.5.1 via NPM module (1.31 backport)

@k8s-ci-robot k8s-ci-robot changed the title Upgrade to Docsy 0.5.1 via NPM module (1.31 backport) [WIP] Upgrade to Docsy 0.5.1 via NPM module (1.31 backport) Dec 12, 2024
@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 Dec 12, 2024
@shurup
Copy link
Member

shurup commented Dec 23, 2024

https://deploy-preview-49031--k8s-v1-31.netlify.app/community/ looks wrong

As I mentioned on Slack, the disappearing footer problem is solved if we remove the <section id="deprecation-warning"> block. However, after further investigation, I found out that not this specific block is a culprit, but having height: 100vh; for .td-outer in the very beginning of _main-container.scss. To be more precise, on some other pages, such as blog, this attribute s overwritten by _custom.scss (it defines height: auto; for .td-outer). Therefore, we need:

a) include _custom.scss on all other pages where it's missing now (they include /, /partners/, and /community/; I could not find any other);
b) OR remove height: 100vh; from the main file (personally, I don't find it too useful for the cases it covers. What it does is display the footer below your first screen for the pages whose content is not enough to fill your whole screen vertically).

@sftim sftim force-pushed the 20241112_1-31_docsy_0-5-1 branch from 465fe08 to 6c973ae Compare December 31, 2024 06:25
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Dec 31, 2024
@sftim
Copy link
Contributor Author

sftim commented Dec 31, 2024

/retitle Upgrade to Docsy 0.5.1 via NPM module (1.31 backport)

Should stay held until PR #48812 merges

@k8s-ci-robot k8s-ci-robot changed the title [WIP] Upgrade to Docsy 0.5.1 via NPM module (1.31 backport) Upgrade to Docsy 0.5.1 via NPM module (1.31 backport) Dec 31, 2024
@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 Dec 31, 2024
@sftim
Copy link
Contributor Author

sftim commented Dec 31, 2024

/hold cancel

#48812 has merged

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Dec 31, 2024
@sftim
Copy link
Contributor Author

sftim commented Jan 2, 2025

I put a workaround in place for the minimum page height, and all looks good.

@shurup
Copy link
Member

shurup commented Jan 7, 2025

The footer looks good in both my browsers now! 👍

However, the #deprecation-warning block displaying the 'Kubernetes v1.31 documentation is no longer actively maintained. [..]' message has width: 100vw (at assets/scss/_custom.scss:1129), which adds an unnecessary horizontal scroll for the /community page in Google Chrome. Changing it to width: 100% fixes the issue. Not sure whether it's relevant to this specific PR(?), so I didn't commit a fix here.

@sftim
Copy link
Contributor Author

sftim commented Jan 7, 2025

If we can save the fix to a follow-up PR, let's do that.

@shurup
Copy link
Member

shurup commented Jan 9, 2025

If we can save the fix to a follow-up PR, let's do that.

Absolutely! I checked this issue for the currently rendered website and realised it's here already (unrelated to this upgrade). Thus, created another PR to fix it: #49364

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

LGTM

Nice that this fixes the missing footers in the Partners and Community pages, e.g.:

image

I'm assuming others have checked the containerized build and serve.

/cc @nate-double-u

@chalin
Copy link
Contributor

chalin commented Jan 30, 2025

Anything holding this back @sftim et all?

@sftim
Copy link
Contributor Author

sftim commented Jan 30, 2025

This PR is waiting on reviewer capacity.

Copy link
Contributor

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

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

I'm assuming others have checked the containerized build and serve.

I've spun this up in a container and it looks good. (With the caveat that I still need to do the api-ref-generator dance - but that's not an issue with this PR)

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 31, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 90b91396d61bc5cc7b578a502975ced73addd9ed

@sftim
Copy link
Contributor Author

sftim commented Jan 31, 2025

containerized build and serve

This is likely to throw up #49460 - and I'm OK with that (people rarely work on the release-1.31 branch with a local preview).

@reylejano
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chalin, reylejano

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

The pull request process is described 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 k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 7, 2025
@k8s-ci-robot k8s-ci-robot merged commit 3f65df5 into kubernetes:release-1.31 Feb 7, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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 lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants