Fix the format of Markdown files

opeco17 commented 1 year ago

What would you like to be added:

We introduced markdownlint-cli2 in https://github.com/kubernetes/kube-state-metrics/pull/2184. But the following rules can't be fixed automatically by markdownlint-cli2 and they're disabled in this configuration.

[ ] MD013
[ ] MD024
[ ] MD033
[ ] MD036
[ ] MD040
[ ] MD041

The format should be fixed manually and then the rules should be enabled.

Why is this needed:

To improve readability of Markdown files

Describe the solution you'd like

Fix the format of Markdown files and enable the rule in this file.

Additional context

dashpole commented 1 year ago

/triage accepted /assign @opeco17

k8s-triage-robot commented 1 month ago

This issue has not been updated in over 1 year, and should be re-triaged.

You can:

Confirm that this issue is still relevant with /triage accepted (org members only)
Close this issue with /close

For more details on the triage process, see https://www.kubernetes.dev/docs/guide/issue-triage/

/remove-triage accepted

dgrisonnet commented 1 month ago

/unassign @opeco17 /help /triage accepted

k8s-ci-robot commented 1 month ago

@dgrisonnet: This request has been marked as needing help from a contributor.

Guidelines

Please ensure that the issue body includes answers to the following questions:

Why are we solving this issue?
To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
Does this issue have zero to low barrier of entry?
How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-help command.

In response to [this](https://github.com/kubernetes/kube-state-metrics/issues/2191): >/unassign @opeco17 >/help >/triage accepted Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

soma00333 commented 1 week ago

@dgrisonnet Hello, I checked this with make lint-markdown-format. We have a lot of tables in .md files, so I think it's challenging to enable MD013(line-length) and MD033(inline-html). If we limit the scope to MD024, MD036, MD040, and md041, I can enable it. The updated .markdownlint-cli2.jsonc is as follows:

{
  "globs": [
    "**/*.md"
  ],
  "config": {
    "MD004": {
      "style": "asterisk"
    },
    "MD013": false, // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md013---line-length
    "MD033": false, // https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md#md033---inline-html
  }
}

What do you think? Thank you.

kubernetes / kube-state-metrics

Fix the format of Markdown files #2191

Guidelines