Skip to content

[Bug]: New Markdown Linter version introduces rules that break the pipeline #7810

Closed
@jjngx

Description

@jjngx

Version

edge

What Kubernetes platforms are you running on?

Kind

Steps to reproduce

Issue: #7797

Markdown linter introduces new rules for referencing links. No single words are allowed, for example: "here".

Error: CHANGELOG.md:695:4 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: CHANGELOG.md:1098:16 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: CHANGELOG.md:1266:4 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: CONTRIBUTING.md:79:87 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: deployments/README.md:4:15 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: examples/custom-resources/oidc/README.md:61:5 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: examples/custom-resources/oidc/README.md:69:41 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: examples/ingress-resources/daemon-set/README.md:7:2 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: examples/shared-examples/rbac/README.md:5:2 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md
Error: Failed with exit code: 1

Activity

added
bugAn issue reporting a potential bug
needs triageAn issue that needs to be triaged
on May 20, 2025
github-actions

github-actions commented on May 20, 2025

@github-actions
Contributor

Hi @jjngx thanks for reporting!

Be sure to check out the docs and the Contributing Guidelines while you wait for a human to take a look at this 🙂

Cheers!

ADubhlaoich

ADubhlaoich commented on May 20, 2025

@ADubhlaoich
Contributor

We generally try to avoid ambiguous link names, so we actually fix these everywhere we can in product documentation - within DocOps, we also apply it to our "process" documentation (non-product documentation, such as READMEs).

I can fix these, otherwise the standard approach is to have the link name as the page or section name for clarity.

linked a pull request that will close this issuefix markdown linter issues #7822on May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugAn issue reporting a potential bugneeds triageAn issue that needs to be triaged

    Type

    No type

    Projects

    Status

    Done 🚀

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @ADubhlaoich@jjngx

      Issue actions

        [Bug]: New Markdown Linter version introduces rules that break the pipeline · Issue #7810 · nginx/kubernetes-ingress