Redo Mermaid shortcode (Docsy alignment) #46681

sftim · 2024-06-05T14:36:22Z

Ready our handling of Mermaid shortcodes so that we can eventually use the vanilla head.html layout from upstream Docsy.

/area web-development
/kind cleanup

Helps with #41171

Existing example | preview

netlify · 2024-06-05T14:39:15Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`ef41204`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/66cdd862e283f50008cb606a
😎 Deploy Preview	https://deploy-preview-46681--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

dipesh-rawat

The changes look good, and the preview works as expected.
/lgtm

/approve (Unofficially giving the nod of approval; official approval required from sig-docs-website-owner)

k8s-ci-robot · 2024-06-05T23:49:20Z

LGTM label has been added.

Git tree hash: b76e040d0b9642a2b9cf71757313bae7f68de34f

dipesh-rawat

Re-applying the label from #46681 (review). The change still looks good to me ;)

/lgtm

k8s-ci-robot · 2024-06-11T16:16:01Z

LGTM label has been added.

Git tree hash: 0a1d3b7fa5e27ec625f5226e144a9dbbb5d33823

chalin

See inline for two minor nits.

/lgtm

chalin · 2024-06-12T06:41:26Z

layouts/partials/hooks/head-end.html

@@ -13,3 +13,13 @@
 {{- if .HasShortcode "cncf-landscape" -}}
 <script src="https://cdnjs.cloudflare.com/ajax/libs/iframe-resizer/4.3.9/iframeResizer.min.js" integrity="sha384-hHTwgxzjpO1G1NI0wMHWQYUxnGtpWyDjVSZrFnDrlWa5OL+DFY57qnDWw/5WSJOl" crossorigin="anonymous"></script>
 {{- end -}}
+
+{{ if .HasShortcode "mermaid" }}
+  <!-- Copied from https://unpkg.com/mermaid@10.6.1/dist/mermaid.min.js -->


I don't see how this comment makes sense anymore It might at some point in the past when part of the .min.js script was embedded here, but that clearly is no longer the case.

Suggested change

Why does this no longer make sense? The point is to let people confirm the value of integrity and also to understand / verify the provenance.

With a statement like "Copied from https://unpkg.com/mermaid@10.6.1/dist/mermaid.min.js" I expect to see code excerpted from the named file and inlined below, but I'm not seeing any such embedded code.

Oh, right, you're doing a get resource, and so losing the link to the source by the same token. Got it.

Yep, the comment is in the place where we do the Get; this lets us ensure that the committed file contents 100% match the minified JS. We prefer to have the files be 100% the same.

One day we might be able to load Mermaid from an external CDN.

chalin · 2024-06-12T06:42:49Z

layouts/partials/hooks/head-end.html

+  {{- with resources.Get "js/mermaid-10.6.1.min.js" -}}
+  <script src="{{ .RelPermalink }}" integrity="sha384-+NGfjU8KzpDLXRHduEqW+ZiJr2rIg+cidUVk7B51R5xK7cHwMKQfrdFwGdrq1Bcz"></script>
+  {{- else -}}
+    <!-- without Mermaid, the site won't appear right -->


Suggested change



{{/* Without Mermaid, the site won't appear right */ -}}

I thought about that, but I went for an HTML comment. The build is about to fail in a few microseconds so I'm not worried about this comment appearing inside the <head> of the final rendered page.

(see the very next line!)

k8s-ci-robot · 2024-06-12T06:43:32Z

@chalin: changing LGTM is restricted to collaborators

In response to this:

See inline for two minor nits.

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

dipesh-rawat

/lgtm

k8s-ci-robot · 2024-08-06T23:26:28Z

LGTM label has been added.

Git tree hash: 53ac7954ba39a89d990f44f872d437224430a628

sftim · 2024-08-07T13:33:00Z

(rebased)

dipesh-rawat

/lgtm

(Would be good to get this merged; official approval required from sig-docs-website-owner)

k8s-ci-robot · 2024-08-11T23:18:28Z

LGTM label has been added.

Git tree hash: 753bc8f8f52e5592a85e4c01889209290e6f7189

Ready this for vanilla Docsy

dipesh-rawat

Re-applying the label from previous review. The change still looks good to me.

/lgtm

k8s-ci-robot · 2024-09-01T23:20:00Z

LGTM label has been added.

Git tree hash: b3ebcab6762b5e5d3d8ce10b2c5ba855432137da

reylejano · 2024-09-03T18:09:59Z

The changes render good to me
/approve

k8s-ci-robot · 2024-09-03T18:10:15Z

[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:

~~OWNERS~~ [reylejano]

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 requested review from divya-mohan0209 and salaxander June 5, 2024 14:36

sftim force-pushed the 20240605_redo_mermaid_shortcode branch from c38f339 to 299a485 Compare June 5, 2024 14:59

sftim marked this pull request as ready for review June 5, 2024 14:59

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 Jun 5, 2024

k8s-ci-robot requested a review from katcosgrove June 5, 2024 14:59

dipesh-rawat reviewed Jun 5, 2024

View reviewed changes

k8s-ci-robot assigned dipesh-rawat Jun 5, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 5, 2024

sftim force-pushed the 20240605_redo_mermaid_shortcode branch from 299a485 to d8290fa Compare June 11, 2024 15:59

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 11, 2024

k8s-ci-robot requested a review from dipesh-rawat June 11, 2024 15:59

dipesh-rawat reviewed Jun 11, 2024

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 11, 2024

chalin approved these changes Jun 12, 2024

View reviewed changes

sftim force-pushed the 20240605_redo_mermaid_shortcode branch from d8290fa to a026f71 Compare August 6, 2024 18:11

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 6, 2024

k8s-ci-robot requested a review from dipesh-rawat August 6, 2024 18:11

nate-double-u self-requested a review August 6, 2024 18:13

dipesh-rawat reviewed Aug 6, 2024

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 6, 2024

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 7, 2024

sftim force-pushed the 20240605_redo_mermaid_shortcode branch from a026f71 to fff5913 Compare August 7, 2024 13:31

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 7, 2024

k8s-ci-robot requested a review from dipesh-rawat August 7, 2024 13:31

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 7, 2024

sftim force-pushed the 20240605_redo_mermaid_shortcode branch from fff5913 to 7af5e6c Compare August 7, 2024 13:32

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 9, 2024

sftim force-pushed the 20240605_redo_mermaid_shortcode branch from 7af5e6c to 66f1749 Compare August 9, 2024 09:49

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 9, 2024

dipesh-rawat reviewed Aug 11, 2024

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 11, 2024

Redo Mermaid shortcode

ef41204

Ready this for vanilla Docsy

sftim force-pushed the 20240605_redo_mermaid_shortcode branch from 66f1749 to ef41204 Compare August 27, 2024 13:45

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 27, 2024

k8s-ci-robot requested a review from dipesh-rawat August 27, 2024 13:45

dipesh-rawat reviewed Sep 1, 2024

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 1, 2024

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 3, 2024

k8s-ci-robot merged commit ae24e82 into kubernetes:main Sep 3, 2024
6 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Redo Mermaid shortcode (Docsy alignment) #46681

Redo Mermaid shortcode (Docsy alignment) #46681

sftim commented Jun 5, 2024 •

edited

Loading

netlify bot commented Jun 5, 2024 •

edited

Loading

dipesh-rawat left a comment

k8s-ci-robot commented Jun 5, 2024

dipesh-rawat left a comment

k8s-ci-robot commented Jun 11, 2024

chalin left a comment

chalin Jun 12, 2024

sftim Jun 12, 2024

chalin Jun 26, 2024

sftim Jun 26, 2024 •

edited

Loading

chalin Jun 12, 2024

sftim Jun 12, 2024

sftim Jun 12, 2024

k8s-ci-robot commented Jun 12, 2024

dipesh-rawat left a comment

k8s-ci-robot commented Aug 6, 2024

sftim commented Aug 7, 2024

dipesh-rawat left a comment

k8s-ci-robot commented Aug 11, 2024

dipesh-rawat left a comment

k8s-ci-robot commented Sep 1, 2024

reylejano commented Sep 3, 2024

k8s-ci-robot commented Sep 3, 2024

	<!-- without Mermaid, the site won't appear right -->
	{{/* Without Mermaid, the site won't appear right */ -}}

Redo Mermaid shortcode (Docsy alignment) #46681

Redo Mermaid shortcode (Docsy alignment) #46681

Conversation

sftim commented Jun 5, 2024 • edited Loading

netlify bot commented Jun 5, 2024 • edited Loading

✅ Pull request preview available for checking

dipesh-rawat left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 5, 2024

dipesh-rawat left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 11, 2024

chalin left a comment

Choose a reason for hiding this comment

chalin Jun 12, 2024

Choose a reason for hiding this comment

sftim Jun 12, 2024

Choose a reason for hiding this comment

chalin Jun 26, 2024

Choose a reason for hiding this comment

sftim Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

chalin Jun 12, 2024

Choose a reason for hiding this comment

sftim Jun 12, 2024

Choose a reason for hiding this comment

sftim Jun 12, 2024

Choose a reason for hiding this comment

k8s-ci-robot commented Jun 12, 2024

dipesh-rawat left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 6, 2024

sftim commented Aug 7, 2024

dipesh-rawat left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Aug 11, 2024

dipesh-rawat left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Sep 1, 2024

reylejano commented Sep 3, 2024

k8s-ci-robot commented Sep 3, 2024

sftim commented Jun 5, 2024 •

edited

Loading

netlify bot commented Jun 5, 2024 •

edited

Loading

sftim Jun 26, 2024 •

edited

Loading