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

[zh-cn] Code-block language should be text in diagram-guide #49431

Open
chalin opened this issue Jan 14, 2025 · 2 comments
Open

[zh-cn] Code-block language should be text in diagram-guide #49431

chalin opened this issue Jan 14, 2025 · 2 comments
Labels
area/localization General issues or PRs related to localization language/zh Issues or PRs related to Chinese language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@chalin
Copy link
Contributor

chalin commented Jan 14, 2025

Originally posted by @chalin in #48724 (review)

Visit the following preview doc page https://deploy-preview-48724--kubernetes-io-main-staging.netlify.app/docs/contribute/style/diagram-guide/#example-2-ingress and you'll see that the "Code block" is rendered as a mermaid diagram rather than raw code, as it is rendered currently:

image

This is because the code-block language is set to mermaid and as of Docsy 0.6.0 such code blocks are rendered as Mermaid diagrams (without the need to use {{<mermaid}}). We need to set the code-block language to text.

The same is true of content/zh-cn/docs/contribute/style/diagram-guide.md.

The issue still needs to be resolved for the zh-cn page, see https://kubernetes.io/zh-cn/docs/contribute/style/diagram-guide/#%E7%A4%BA%E4%BE%8B-2-ingress:

Image

/cc @SayakMukhopadhyay @sftim @nate-double-u

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jan 14, 2025
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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

sftim commented Jan 14, 2025

/area localization
/language zh
/priority backlog

@k8s-ci-robot k8s-ci-robot added area/localization General issues or PRs related to localization language/zh Issues or PRs related to Chinese language priority/backlog Higher priority than priority/awaiting-more-evidence. labels Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/localization General issues or PRs related to localization language/zh Issues or PRs related to Chinese language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

No branches or pull requests

3 participants