ceph / ceph-csi-operator

Kubernetes operator for managing the CephCSI plugins
Apache License 2.0
16 stars 16 forks source link

Add a makefile target for markdown linter check #159

Open Madhu-1 opened 1 month ago

Madhu-1 commented 1 month ago

Not sure what is the standard in this project, but wouldn't it be nice and convenient to add a make target for running markdown lint so that it can easily be invoked locally by developers and this same make target would be invoked in the ci workflow?

@nb-ohad , @Madhu-1 - wdyt?

Originally posted by @obnoxxx in https://github.com/ceph/ceph-csi-operator/issues/16#issuecomment-2410474153

nb-ohad commented 4 weeks ago

@Madhu-1 Why do we need a markdown target where tunning the linter is already a one-liner? If my assumption about the request is wrong, and the intent her is that we will run multiple linter using a single command then I am ok with this

Madhu-1 commented 4 weeks ago

The request is to have a makefile target that uses the same version of linter that we have in CI and also passes the right configuration file where the developer does need not to worry about running static checks