Skip to content

Upgrade to Docsy 0.5.1 via NPM module#48812

Merged
k8s-ci-robot merged 1 commit intokubernetes:mainfrom
chalin:chalin-im-docsy-0.5.1-2024-11-22
Dec 31, 2024
Merged

Upgrade to Docsy 0.5.1 via NPM module#48812
k8s-ci-robot merged 1 commit intokubernetes:mainfrom
chalin:chalin-im-docsy-0.5.1-2024-11-22

Conversation

@chalin
Copy link
Copy Markdown
Contributor

@chalin chalin commented Nov 23, 2024

Also addresses and closes the following:

Previews

Checks I've done

I've checked that the following render correctly, feel free to double check:

  • Icons (now that we're using FA v6) render properly in the
    • Footer
    • Doc pages, page-meta-links section
    • Blog pages, page-meta and other links
    • More rarely used icons like the third-party icon (in page-meta), for example see Concepts > Windows
  • Mermaid diagrams continue to render correctly
  • Tooltips are still working, demonstrating that the new way to fetch and use Bootstrap CSS and JS is working
  • Code-blocks and figures render correctly

Followup changes

This PR makes minimal changes. Consider following up with updates to:

Related:

@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 23, 2024
@k8s-ci-robot k8s-ci-robot requested a review from sftim November 23, 2024 00:06
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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 Nov 23, 2024
@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 23, 2024

Pull request preview available for checking

Name Link
🔨 Latest commit 30b92ff
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67570039ac9a3d00088ef4c8
😎 Deploy Preview https://deploy-preview-48812--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.

Comment thread Makefile Outdated
Comment thread Makefile Outdated
Comment thread Makefile
@chalin chalin force-pushed the chalin-im-docsy-0.5.1-2024-11-22 branch from 6f9c896 to 8f41bef Compare November 23, 2024 20:40
Comment on lines +58 to +60
<meta name="description" content="{{ template "partials/page-description.html" . }}">
<meta property="og:description" content="{{ template "partials/page-description.html" . }}">
<meta name="twitter:description" content="{{ template "partials/page-description.html" . }}">
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice

Comment thread netlify.toml Outdated
@chalin chalin force-pushed the chalin-im-docsy-0.5.1-2024-11-22 branch from 8f41bef to b745980 Compare November 23, 2024 20:44
@sftim
Copy link
Copy Markdown
Contributor

sftim commented Nov 23, 2024

Try running mv node_modules node_modules_moved_aside before trying a local preview in a container. That should show up the snags, if there are any.

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Nov 23, 2024

Hope this is OK
/retitle [WIP] Upgrade to Docsy 0.5.1 via NPM module

@k8s-ci-robot k8s-ci-robot changed the title Upgrade to Docsy 0.5.1 via NPM module [WIP] Upgrade to Docsy 0.5.1 via NPM module Nov 23, 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 Nov 23, 2024
@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Nov 23, 2024

@sftim wrote via #48811 (comment):

You won't like this @chalin but the <i class="fa fa-icon-circle fa-fw"></i> was a bodge to get a correctly-indented second line with no icon.

That's the original presentation intent, so bear that in mind when considering what we'd like to preserve…

Yes, here's the fix I propose: a65258e. It looks like this:

image

which you can see via https://deploy-preview-48812--kubernetes-io-main-staging.netlify.app/docs/concepts/windows/.

@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Nov 25, 2024

Hope this is OK /retitle [WIP] Upgrade to Docsy 0.5.1 via NPM module

@sftim - with the latest changes, this is ready for reivew -- and so not WIP. The Docker & build script issues being orthogonal to the Docsy upgrade.

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Nov 25, 2024

If this breaks local previewing in a container, we can't merge it.

Anyway, based on #48812 (comment)

/retitle Upgrade to Docsy 0.5.1 via NPM module

@k8s-ci-robot k8s-ci-robot changed the title [WIP] Upgrade to Docsy 0.5.1 via NPM module Upgrade to Docsy 0.5.1 via NPM module Nov 25, 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 Nov 25, 2024
Copy link
Copy Markdown
Member

@Okabe-Junya Okabe-Junya left a comment

Choose a reason for hiding this comment

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

Great work, thank you chalin!!
LGTM

@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Dec 5, 2024

If this breaks local previewing in a container, we can't merge it.

@sftim - no, the simple change to the Docker file in this PR does not introduce any further breakages to local containerized build that might not have been there before.

Thanks @Okabe-Junya.
All: anything further to be done here? I'd like to move on to the next Docsy upgrade steps. Thanks!

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 5, 2024

If you don't run npm first, the effect of this PR is to break container previewing (you never previously had to run npm).

Error: command error: failed to load modules: module "docsy" not found in "/src/node_modules/docsy"; either add it as a Hugo Module or store it in "/src/node_modules".: module does not exist

Comment thread README.md
@chalin chalin force-pushed the chalin-im-docsy-0.5.1-2024-11-22 branch from a65258e to 8058613 Compare December 7, 2024 00:47
@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Dec 7, 2024

Try running mv node_modules node_modules_moved_aside before trying a local preview in a container. That should show up the snags, if there are any.

@sftim - oh, you're right! Sorry for having missed that earlier. I'm looking into a solution.

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 9, 2024

Let's totally squash it on merge (I recommend that for all our projects). I was just hoping to keep the individual commits in this PR's branch history.

Noted, but this project prefers to preserve commits from the PR.

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 9, 2024

Before said squash, the final commit is / was d8392cc.

@chalin chalin force-pushed the chalin-im-docsy-0.5.1-2024-11-22 branch from d8392cc to 30b92ff Compare December 9, 2024 14:35
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 9, 2024
@k8s-ci-robot k8s-ci-robot requested a review from sftim December 9, 2024 14:35
@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Dec 9, 2024

@sftim - PR rebased and squashed to 1 commit.

@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Dec 9, 2024

Before said squash, the final commit is / was d8392cc.

Is this a way to keep access to the commit history before the squash? Does GitHub keep all intermediate commits even after they've been overwritten by a force-pushed? (If so, that's good to know!)

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 9, 2024

(you can fetch a commit directly from GitHub, but possibly it may eventually get garbage collected)

@nate-double-u
Copy link
Copy Markdown
Contributor

nate-double-u commented Dec 10, 2024

I'm able to build from a fresh install both locally and using a container, but in both cases I need to do a pushd api-ref-generator && git fetch --unshallow && popd in order to get make module-init to work before things build. (I actually have do do make module-init twice, otherwise things aren't ready for the git fetch.)

reapplying lgtm

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 10, 2024
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: e27c6e8d1e8af583c3165fc850051e45cbe0b516

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 10, 2024

/hold

To make life easier, do not merge or unhold this until Kubernetes v1.32 is released. OK to unhold afterwards.

@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 10, 2024
@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 12, 2024

/hold cancel

@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 31, 2024

/approve

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: sftim

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

The pull request process is described here

Details 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 Dec 31, 2024
@sftim
Copy link
Copy Markdown
Contributor

sftim commented Dec 31, 2024

/remove-label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot removed the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Dec 31, 2024
@k8s-ci-robot k8s-ci-robot merged commit ce1d8e2 into kubernetes:main Dec 31, 2024
@chalin chalin deleted the chalin-im-docsy-0.5.1-2024-11-22 branch January 9, 2025 12:21
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. 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

5 participants