Fix markdownlint in site
#1499
Merged
Fix markdownlint in site
#1499
+13
−11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
lucacome
commented
Jan 23, 2024
sjberman
reviewed
Jan 23, 2024
site/content/how-to/traffic-management/integrating-cert-manager.md
Outdated
Show resolved
Hide resolved
sjberman
reviewed
Jan 23, 2024
Problem: The configuration for the `site` directory didn't have a standard name and wasn't getting picked up by markdownlint-cli. The Makefile was also referencing .markdownlint.yaml that doesn't exist. Also the configuration for .pre-commit-config.yaml was invalid and the autoupdate wasn't working correctly. Solution: Change the name of the configuration to a standard one that can be used automatically be the tool. Update pre-commit config and Makefile and run the linter to fix the existing problems.
lucacome
force-pushed
the
chore/markdown
branch
from
8369b19 to
331dbbf
Compare
sjberman
approved these changes
Jan 23, 2024
kate-osborn
approved these changes
Jan 23, 2024
Definitely not IMO. There's a lot about that Makefile that is non-functional in my opinion: Vale isn't currently used/enforced, for example. Hack at anything pipeline related until it works the way you want it to, we'll prioritise merging improvements at a later point. |
ADubhlaoich
approved these changes
Jan 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Problem: The configuration for the
sitedirectory didn't have a standard name and wasn't getting picked up by markdownlint-cli. The Makefile was also referencing .markdownlint.yaml that doesn't exist.Also the configuration for .pre-commit-config.yaml was invalid and the autoupdate wasn't working correctly.
Solution: Change the name of the configuration to a standard one that can be used automatically be the tool.
Update pre-commit config and Makefile and run the linter to fix the existing problems.
Checklist
Before creating a PR, run through this checklist and mark each as complete.