Migrated the Ruby Linter to NodeJS Linter

[Ajay-singh1]

Description

This PR replaces the Ruby linter to a modern NodeJS linter which is more flexible and advanced.

The linter passes all the docs test successfully and also it resolves #7906.

This PR fixes issue No. #15148

Reviewers

• Ambient
• Docs
• Installation
• Networking
• Performance and Scalability
• Extensions and Telemetry
• Security
• Test and Release
• User Experience
• Developer Infrastructure
• Localization/Translation

[istio-testing]

Hi @Ajay-singh1. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[Ajay-singh1]

@craigbox The previous PR got cluttered up so I had to create a new one.Regarding the MD007 rule the ruby based linter doesnt strictly enforce the MD007 rule and allows mixed indentation while the node based linter enforces strict MD007 rule so a much better solution will be to disable the MD007 rule.Once the check passes here I will update the common files so that the change is applied to all istio repos.The linting is sucessful now:-

[dhawton]

@craigbox The previous PR got cluttered up so I had to create a new one.Regarding the MD007 rule the ruby based linter doesnt strictly enforce the MD007 rule and allows mixed indentation while the node based linter enforces strict MD007 rule so a much better solution will be to disable the MD007 rule.Once the check passes here I will update the common files so that the change is applied to all istio repos.The linting is sucessful now:-

I actually strongly disagree with disabling MD007. This should be something we enforced, it's been something I have been fixing in PRs that I review, it'd be much better to enforce and resolve the issues.

[Ajay-singh1]

@dhawton I need a couple of days to come up with a solution.Will be right back.

[Arhell]

/ok-to-test

[Ajay-singh1]

/retest

[Ajay-singh1]

@dhawton markdownlint-cli2 is not being recognized.

[Ajay-singh1]

/retest-required

[Ajay-singh1]

Complex Issue unable to resolve closing this.

[craigbox]

@Ajay-singh1 are you intending to pick this up elsewhere? I think you have everything you need to proceed, and I can help steward it. Otherwise I can move it onto another maintainer.

[Ajay-singh1]

@craigbox Yes , this will work and will pass all the lint checks.I am waiting for the PR to be merged in istio/tools once it is approved the checks will pass here and we are good to go.

[craigbox]

I don't see a PR. Can you link one if it exists? Else, do you want to add it to istio/tools#3161 ?
(I would also add both for the meantime)

[Ajay-singh1]

Yes this specific PR I was talking about istio/tools#3161.It is in pending state once it merges the lint checks will pass here I am completely confident about it.

[Ajay-singh1]

/retest

[craigbox]

You may have to wait a day or so for the automator to build a new container and update this repo to use it.

[Ajay-singh1]

👍

[Ajay-singh1]

/retest

[craigbox]

Try pushing an empty commit. it will probably retest on an existing image otherwise

[craigbox]

Nice! The build is working.

The gencheck error is because you added a <!-- markdownlint-disable --> block to a code snippet, but not to the generated snips.sh file. However, I would suggest we shouldn't have an ignore block anywhere but the front matter of a document.

I would also like to standardize on using a markdownlint-disable: XXX block in the doc front matter. Can we see if this is natively supported or how we might need to introduce it?

[craigbox]

This content is now in the YAML files that are used for testing, which will almost certainly cause all the tests to fail.

[Ajay-singh1]

I agree with you I will fix this within a day.After reviewing the documentation I found that it doesnt`t support rules in doc frontmatter disabling the rules through inline html comments is the optimal way.

[craigbox]

Yeah, that's confirmed here: DavidAnson/markdownlint#1250

unfortunate.

[istio-testing]

@Ajay-singh1: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
doc.test.profile-default_istio.io	e3e7746	link	true	/test doc.test.profile-default
doc.test.profile-none_istio.io	e3e7746	link	true	/test doc.test.profile-none

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[craigbox]

This rule is disabled in many files. Can you look into why they are failing, and if we can just change the markup to pass correctly? Did we not have this rule in the old config?

[Ajay-singh1]

We did have this rule in the old configuration.It is failing because markdownlint-cli2 enforces strict MD007 rules while the previous linter allows for mixed indentation for the MD007 rule.Changing markup will have several breaking changes.

[craigbox]

Does this turn off the default rules? Wouldn't we want them on?

[Ajay-singh1]

Yes this will turn off the default rules , no turning them on is not a good way because all the rules will be applied by default which is used by the linter and we dont want them right?We will explicitly define the rules which we want to use to lint our markdown files.

[Ajay-singh1]

I have addressed all the issues , We can cleanly merge this PR , If you have any further questions do let me know.Thanks @dhawton and @craigbox for your assistance.