Bump Docsy to 0.6.x#48724
Conversation
✅ Pull request preview available for checkingBuilt without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
LGTM label has been added. DetailsGit tree hash: ce181c72da3a99a11aa14ca37cb7a32c391acd56 |
c7d6601 to
76b7102
Compare
|
New changes are detected. LGTM label has been removed. |
76b7102 to
76b7ce8
Compare
|
Hmm, I think this needs a new approach. I hope to get time to revisit it. |
|
@sftim: Closed this PR. DetailsIn response to this:
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. |
It appears to be rendering properly now: What appears off to you? |
chalin
left a comment
There was a problem hiding this comment.
@sftim - can you also fix content/zh-cn/docs/contribute/style/diagram-guide.md by changing ```mermaid to ```text, since it requires the same fix as the English page: https://deploy-preview-48724--kubernetes-io-main-staging.netlify.app/zh-cn/docs/contribute/style/diagram-guide/#%E7%A4%BA%E4%BE%8B-2-ingress
I was going to check with the Chinese localization team about how they want to cover this. |
chalin
left a comment
There was a problem hiding this comment.
Pending resolution of #48724 (comment), which may or may not be in scope of this PR (if not, an issue should be created to keep track of the required change), LGTM
/cc @nate-double-u
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: chalin, lhajouji, salaxander The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Btw, my previous LGTM of this PR is for the minimal changes it introduced in support of bumping up the version of Docsy to 0.6.x -- this is done is in the "minimalist" spirit of #44002. In particular, the Docsy 0.6.x Mermaid enhancements are not being integrated here. I'm assuming that this will be done later in scope of #41171. |
|
We're all for minimal useful changes and small reviewable PRs. |
|
After this merges, let's try to tidy up our use of Mermaid and align it to what upstream Docsy recommends. |
Yes, it does (going through the same submodule management process I had to go through for your earlier PR (#48812)) |
|
A few points and nits
It seems like the issue lies in which uses a wrong integrity hash. Changing the hash to the one expected by the browser gets the mermaid diagrams to render properly. The tricky questions are:
Apart from this I have this related question (#48724 (comment)) but otherwise the PR is fine. |
|
I think the Mermaid part might need more work. That's a shame. C'est la vie. |
You can get the mermaid to work by changing the integrity hash in the mermaid library that is getting imported. At least until we remove the shortcode and convert all mermaid diagrams to use code fencing. |
|
@SayakMukhopadhyay if you'd like to, you're very welcome to take over this PR - feel free to make your own local branch and cherry pick any useful commit from this one. I've more K8s WIP than I've capacity to look after; I've been leading on the Docsy upgrade partly because at the time nobody else was working on it. I get the sense you could easily get this one over the line; also, if you send in a PR and it looks good, I can LGTM it. |
Yeah, I can give it a go but I hope I am not stepping on any toes. |
|
These toes are made for steppin' |
|
Closing in favor of #49416 /close |
|
@sftim: Closed this PR. DetailsIn response to this:
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. |
|
@sftim et all: why was this PR closed? It was a valid and fully functional update to Docsy 0.6.x, with Mermaid diagrams correctly rendering, ready to be merged. It was also understood that any further Mermaid compatibility issues would be handled in a followup PR, as Tim wrote:
|
|
When I checked this, I wasn't seeing the Mermaid diagrams rendering correctly across all browsers; some pages did look OK in some browsers, but that wasn't enough for me to think it was good to merge. Also, I'm very happy for @SayakMukhopadhyay - or anyone else - to pick up the baton. We need to at least not break Mermaid vs. the existing experience. |
Will follow through with: now that this PR has been closed. |


This PR upgrades to a newer version of Docsy: 0.6.0 (preview)
Relevant to issue #44002
In the testing I've done, I haven't found any different look or behavior that still needs fixing.
/area web-development
This PR incorporates the commits from PRs: