docs: Add cli refrences to the docs around annotations and labels

[dfredell]

What this PR does / why we need it: Add links to the command line flags for enabling labels and annotations in the docs

As the docs sit today we had struggled with figuring out why the kube_pod_labels metric were not getting label_POD_LABEL to populate. When we read docs/pod-metrics.md, we got the impression that all LABELS would be scraped and should appear in the metrics. The kubernetes pod itself had the labels on it.
We then stumbled upon #1489 (comment) and lead us to figure out that not all LABELS were extracted by default. Adding --metric-labels-allowlist solved our issue. So this MR is intended to make it more obvious when reading docs/pod-metrics.md that all labels are not scraped by default.

I only added the link to cli-arguments.md on docs that had the Description column.

How does this change affect the cardinality of KSM: does not change cardinality

Which issue(s) this PR fixes : fixes #1489

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: dfredell / name: Dan Fredell (417e9c9, b1991d6, 6bf2df6, 66a6cae, dcb8cf5)

[k8s-ci-robot]

Welcome @dfredell!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[logicalhan]

/triage accepted
/assign @CatherineF-dev

[fpetkovski]

Thanks for the contribution 👍

/lgtm

[fpetkovski]

/hold for @CatherineF-dev to take a look

[dfredell]

I presented/ reviewed this PR with my team and they caught some of my miss spellings, so I fixed, squashed, and pushed.
s/controled/controlled/ s/persistant/persistent/

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

• Mark this PR as fresh with /remove-lifecycle stale
• Close this PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[dgrisonnet]

Hi @dfredell, sorry for letting your PR go stale. The docs improvements that you are proposing look good to me, but it would be great if you could propagate them to all the docs referencing label/annotation metrics.

You can easily find those by running:

grep -rlE "_(labels|annotations)" docs

/remove-lifecycle stale
/unhold
/assign

[dfredell]

@dgrisonnet These docs tables were incredibly hard to read in a text editor without extra white space and formatting. So I through them through https://open-vsx.org/extension/yzhang/markdown-all-in-one

I have added the Description column to those MDs that didn't have them as requested.

[dgrisonnet]

@mrueg @rexagod any thoughts on this new format for the docs? I am personally fine with the change, but we will need to add a step to the lint to make sure it sticks.

[mrueg]

We could probably run https://github.com/marketplace/actions/markdownlint-cli2-action if we wanted to to improve our markdown formatting.

[dgrisonnet]

I am fine with merging it then. @dfredell thank you for the contribution :)

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dfredell, dgrisonnet, fpetkovski

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 [dgrisonnet]

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