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 #48812

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

chalin
Copy link
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:

@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
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 tengqm for approval. For more information see the Kubernetes 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

@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
Copy link

netlify bot commented Nov 23, 2024

Pull request preview available for checking

Name Link
🔨 Latest commit a65258e
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/674249352720160008804f0b
😎 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.

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@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
Contributor

Choose a reason for hiding this comment

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

Nice

netlify.toml Outdated Show resolved Hide resolved
@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
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
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
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
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
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
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. 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
3 participants