Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jjngx opened this issue May 20, 2025 · 2 comments · Fixed by #7822
Closed

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

jjngx opened this issue May 20, 2025 · 2 comments · Fixed by #7822
Labels
bug An issue reporting a potential bug needs triage An issue that needs to be triaged

Comments

@jjngx
Copy link
Contributor

jjngx commented May 20, 2025

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
@jjngx jjngx added bug An issue reporting a potential bug needs triage An issue that needs to be triaged labels May 20, 2025
Copy link

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
Copy link
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.

@jjngx jjngx mentioned this issue May 21, 2025
6 tasks
@jjngx jjngx linked a pull request May 21, 2025 that will close this issue
6 tasks
@github-project-automation github-project-automation bot moved this from Todo ☑ to Done 🚀 in NGINX Ingress Controller May 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An issue reporting a potential bug needs triage An issue that needs to be triaged
Projects
Status: Done 🚀
Development

Successfully merging a pull request may close this issue.

2 participants