Reference documentation for kube components

[tengqm]

No description provided.

[netlify]

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 9a8fa16

https://deploy-preview-13444--kubernetes-io-master-staging.netlify.com

[DanyC97]

@tengqm quick question (more for my own understanding): assuming #13117 gets in, i guess we can replace all the html code in the markdown file with the new shortcode, is that correct?

[jimangel]

/hold

Thanks @tengqm for the fast work! I would like to test the instructions and validate from an outside perspective before merging this so you don't need to do this again in 3 months :)

ref: #13396

[tengqm]

@DanyC97 Code for generating the table can be found here. We were generating HTML tables directly because:

1. We want better control over the rendering of the table, see line 243-255 in the above file. This is not doable using plain markdown syntax.
2. We prefer scrollable tables over verbatim dumps of help message because the latter is very difficult o read.
3. Fortunately, we can embed HTML tables in markdown docs thanks to the markdown engine!

#13117 is solving a different problem regarding the syntax needed for markdown tables.

[jimangel]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jimangel

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:

• OWNERS [jimangel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[jimangel]

/hold cancel

[DanyC97]

@tengqm many thanks for the info!