Skip to content

migrate from markdownlint (ruby) to markdownlint (node JS) #15148

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

Open
craigbox opened this issue May 20, 2024 · 6 comments
Open

migrate from markdownlint (ruby) to markdownlint (node JS) #15148

craigbox opened this issue May 20, 2024 · 6 comments
Labels
good first issue Indicates a good first issue for new contributors help wanted Indicates a PR/Issue that needs community help

Comments

@craigbox
Copy link
Contributor

craigbox commented May 20, 2024

Either of these:

use the engine https://github.com/DavidAnson/markdownlint, which is based on https://github.com/markdownlint/markdownlint but seems more actively maintained.

Replacing our existing implementation with one of them will allow to access useful behaviour such as ignoring rules.

To fix this issue:

@craigbox craigbox added community/help wanted good first issue Indicates a good first issue for new contributors help wanted Indicates a PR/Issue that needs community help labels May 20, 2024
@ayushrakesh
Copy link
Contributor

@craigbox I want to work in this issue, can you please elaborate more about how this can be done. I am not able to understand properly.

@rashmi43
Copy link

I would like to take up this issue

@rashmi43
Copy link

rashmi43 commented Jun 28, 2024

I have created a PR for the same: #15360

@craigbox
Copy link
Contributor Author

Please note that the issue here refers to changing the engine used to verify all the istio.io docs. It's a systems engineering/integration task, not a configuration or docs task.

@rashmi43
Copy link

rashmi43 commented Jul 4, 2024

todos:
You would need to learn how the current script/build tools use the Ruby version of markdownlint, update them to package and use the Node.JS version, and then update the configuration to match our existing rules.

You may also need to do a mass update of the docs to fix any behaviour we can't configure around.

@rashmi43
Copy link

rashmi43 commented Jul 4, 2024

figured out how the ruby version of markdownlint is used, trying to replace with nodejs version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Indicates a good first issue for new contributors help wanted Indicates a PR/Issue that needs community help
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants