docs: Update to use markdownlint compatible markdown contents #11787
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
Signed-off-by: sudosubin <sudosubin@gmail.com>
agilgur5
approved these changes
Sep 9, 2023
There was a problem hiding this comment.
LGTM
I'm not sure about updating the markdown templates in
.githubpath as well, so please check about this.
That's fine, the changes are tiny and make sense. There is just going to be a visible disable comment, but nbd.
Next PR, I will update the generated documents to be generated well.
Are you planning to also change the Makefile to run markdownlint on these files?
Yes, of course. After changing the original go code (mainly the comments), codegen script, and openapi/json schema files, I will also update the Makefile. 👍 |
terrytangyuan
approved these changes
Sep 11, 2023
9 tasks
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.
Related with #11733
Motivation
Argo Workflows project has markdownlint configuration, but many markdown documents does not respect the lint rules. (I'm currently working on markdownlint.)
Modifications
.githubpath as well, so please check about this.Verification
$ markdownlint *.md docs/CONTRIBUTING.md examples manifests sdks/CONTRIBUTING.md (clear)