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

Use markdown instead of html escape chars #18857

Closed
anshprat opened this issue Jan 25, 2020 · 2 comments
Closed

Use markdown instead of html escape chars #18857

anshprat opened this issue Jan 25, 2020 · 2 comments
Labels
language/en Issues or PRs related to English language lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor.

Comments

@anshprat
Copy link
Contributor

anshprat commented Jan 25, 2020

This is a Bug Report

Problem:
The code in https://github.com/kubernetes/website/blob/master/content/en/docs/contribute/style/write-new-topic.md uses escaped HTML chars to display. The following

{{< codenew file="<RELPATH>/my-example-yaml>" >}}

is displayed using

<pre>&#123;&#123;&lt; codenew file="&lt;RELPATH&gt;/my-example-yaml&gt;" &gt;&#125;&#125;</pre>
The code can be much better than the existing escaped HTML by using markdown properly which will help in easier maintenance and reference.

Found this issue while working on #18245

Proposed Solution:
Use markdown instead of escaped chars.

Page to Update:
https://kubernetes.io/docs/contribute/style/write-new-topic/#including-code-from-another-file

@savitharaghunathan
Copy link
Member

/language en
/lifecycle active

@k8s-ci-robot k8s-ci-robot added lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor. language/en Issues or PRs related to English language labels Jan 25, 2020
@bdwill
Copy link

bdwill commented Feb 4, 2020

This appears to be fixed in PR #18858

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language lifecycle/active Indicates that an issue or PR is actively being worked on by a contributor.
Projects
None yet
Development

No branches or pull requests

4 participants