-
Notifications
You must be signed in to change notification settings - Fork 90
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
Fix markdownlint in site
#1499
Fix markdownlint in site
#1499
Conversation
site/content/how-to/traffic-management/integrating-cert-manager.md
Outdated
Show resolved
Hide resolved
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.
8369b19
to
331dbbf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Do we need @nginxinc/nginx-docs to sign off?
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving for posterity.
Proposed changes
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.
Checklist
Before creating a PR, run through this checklist and mark each as complete.