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

[craigbox]

Either of these:

• https://github.com/igorshubovych/markdownlint-cli
• https://github.com/DavidAnson/markdownlint-cli2

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:

• replace one with the other
• validate that the doc repo still passes the tests
• make sure #7906 is addressed

[ayushrakesh]

@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]

I would like to take up this issue

[rashmi43]

I have created a PR for the same: https://github.com/istio/istio.io/pull/15360

[craigbox]

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]

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]

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