Skip to content
This repository was archived by the owner on Aug 7, 2025. It is now read-only.

exclude MD059 from markdownlint#1767

Merged
HarshCasper merged 1 commit intomainfrom
fix-markdownlint
May 12, 2025
Merged

exclude MD059 from markdownlint#1767
HarshCasper merged 1 commit intomainfrom
fix-markdownlint

Conversation

@alexrashed
Copy link
Member

Motivation

Markdownlint version 0.38 introduced a new rule MD059.
This rule fails on several lines on the current main:

$ make lint
markdownlint-cli2 --fix
markdownlint-cli2 v0.18.0 (markdownlint v0.38.0)
Finding: content/**/*.md !node_modules !content/en/tutorials/cloud-pods-collaborative-debugging/* !content/en/user-guide/integrations/terraform/* !content/en/user-guide/aws/events/* !content/en/references/coverage/_index.md !content/en/getting-started/installation.md
Linting: 393 file(s)
Summary: 14 error(s)
content/en/references/configuration.md:174:107 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/aws/athena/index.md:117:83 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/aws/emr/index.md:27:164 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/codebuild/index.md:173:41 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/github-actions/index.md:101:41 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/github-actions/index.md:140:42 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/github-actions/index.md:171:49 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/gitlab-ci/index.md:137:55 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/gitlab-ci/index.md:160:55 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/gitlab-ci/index.md:175:41 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/ci/gitlab-ci/index.md:214:42 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/integrations/architect/index.md:20:111 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/integrations/sdks/dotnet/index.md:77:69 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]
content/en/user-guide/integrations/sdks/java/index.md:158:2 MD059/descriptive-link-text Link text should be descriptive [Context: "[here]"]

This also causes the Docs Parity Action to fail, f.e. in this run.

This PR simply disables this action for now.

Changes

  • Disable markdownlint's MD058 ("Link text should be descriptive")

@github-actions
Copy link

github-actions bot commented May 12, 2025

🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1767.surge.sh 🎊

@HarshCasper HarshCasper merged commit a8ba1c9 into main May 12, 2025
4 checks passed
@HarshCasper HarshCasper deleted the fix-markdownlint branch May 12, 2025 09:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants