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

Documentation Style Section: Replace HTML tables with Markdown tables #16102

Closed
2 tasks
aimeeu opened this issue Aug 27, 2019 · 2 comments · Fixed by #16190
Closed
2 tasks

Documentation Style Section: Replace HTML tables with Markdown tables #16102

aimeeu opened this issue Aug 27, 2019 · 2 comments · Fixed by #16190
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence.

Comments

@aimeeu
Copy link
Contributor

aimeeu commented Aug 27, 2019

This is a Bug Report

Problem:
The tables in the Style sections are coded in HTML instead of Markdown. Tables headers are missing or not rendered with the same style as tables rendered from Markdown. The rest of the documentation contains tables in Markdown.

Proposed Solution:
Update the following pages, replacing HTML tables with Markdown tables:

  • docs/contribute/style/style-guide.md
  • docs/contribute/style/write-new-topic.md

Kubernetes documentation uses GitHub-flavored markdown. Consider adding table captions to support the use of screen readers. See https://kubernetes.io/docs/contribute/style/style-guide/#tables

Page to Update:
https://kubernetes.io/docs/contribute/style/style-guide/
https://kubernetes.io/docs/contribute/style/write-new-topic/

@savitharaghunathan
Copy link
Member

/assign

@sftim
Copy link
Contributor

sftim commented Sep 11, 2019

/priority backlog
/kind feature

@k8s-ci-robot k8s-ci-robot added priority/backlog Higher priority than priority/awaiting-more-evidence. kind/feature Categorizes issue or PR as related to a new feature. labels Sep 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. priority/backlog Higher priority than priority/awaiting-more-evidence.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants