search

kubernetes / kube-state-metrics

Add-on agent to generate and expose cluster-level metrics.
https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/
Apache License 2.0
5.21k stars 1.93k forks source link

chore: lint README.md #2324

Open rexagod opened 4 months ago

rexagod commented 4 months ago

To primarily avoid conflicts and allow for automations.

k8s-ci-robot commented 4 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rexagod

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](https://github.com/kubernetes/kube-state-metrics/blob/main/OWNERS)~~ [rexagod] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
mrueg commented 4 months ago

We already have https://github.com/DavidAnson/markdownlint-cli2 integration, why do we need another markdown formatter/linter?

rexagod commented 4 months ago

markdownlint-cli2 wasn't able to lint the compatibility matrix, owing to which the padding logic would differ before and after the substitution or insertions were performed there. So running a linter that ensured an overall consistent README.md format would ensure no merge conflicts happen owing to matrix padding.

dashpole commented 4 months ago

/assign @CatherineF-dev /triage accepted

mrueg commented 4 months ago

markdownlint-cli2 wasn't able to lint the compatibility matrix, owing to which the padding logic would differ before and after the substitution or insertions were performed there. So running a linter that ensured an overall consistent README.md format would ensure no merge conflicts happen owing to matrix padding.

My preference would be a README.md.tpl doc that is authoritative to generate the README.md + a config file, see https://docs.gomplate.ca/usage/ for example.

k8s-ci-robot commented 3 months ago

PR needs rebase.

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/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
k8s-triage-robot commented 2 weeks ago

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

This bot triages PRs according to the following rules:

You can:

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

/lifecycle stale