Skip to content

Conversation

@kennygt51
Copy link
Contributor

  • Add @docusaurus/theme-mermaid dependency (v3.9.2)
  • Enable Mermaid configuration in docusaurus.config.ts
  • Configure Mermaid theme for diagram rendering support

This enables the documentation site to render Mermaid diagrams
directly in markdown files, allowing for better visual documentation
of architecture, workflows, and system designs.

The following diagrams is examples image using Mermaid to describe relationships.

diagram_samples

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 20, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @kennygt51. Thanks for your PR.

I'm waiting for a github.com member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 20, 2025
Copy link
Member

@a-hilaly a-hilaly left a comment

Choose a reason for hiding this comment

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

Not opposed to this - i can see it being used in the website.

cc @jakobmoellerdev

/approve
/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 21, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: a-hilaly, kennygt51

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 Nov 21, 2025
@jakobmoellerdev
Copy link
Member

please fixup the test run / finding, thanks! (you can downgrade to 3.9.1 first and then have another commit that bumps docusaurus to 3.9.2)

This enables the documentation site to render Mermaid diagrams
directly in Markdown filesm, allowing for better visual documentation
or relationships between components
@kennygt51
Copy link
Contributor Author

@jakobmoellerdev

please fixup the test run / finding, thanks! (you can downgrade to 3.9.1 first and then have another commit that bumps docusaurus to 3.9.2)

Thank you for your review.
I've fixed issue related to Docsaurs versioning.
Could you please review this PR again.

@jakobmoellerdev
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 25, 2025
@kennygt51
Copy link
Contributor Author

I've not execute npm install @docusaurus/[email protected] so there were some issues about npm run build. I've already fixed it.

@jakobmoellerdev
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 25, 2025
@k8s-ci-robot k8s-ci-robot merged commit 7a98f5a into kubernetes-sigs:main Nov 25, 2025
7 checks passed
@kennygt51 kennygt51 deleted the docsaurs_mermaid branch November 25, 2025 22:53
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. 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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants