istio/istio.io

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

Open

#15,148 创建于 2024年5月20日

在 GitHub 查看
 (6 评论) (0 反应) (0 负责人)HTML (740 star) (1,492 fork)batch import
good first issuehelp wanted

描述

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:

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

贡献者指南

技术栈
nodejs
领域
developer experienceci cd
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
Resolution of issue #7906Familiarity with Node.jsUnderstanding of markdownlintExperience with CI configuration
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
45
研究方向
Investigate the current markdownlint setup in the istio.io repository, likely in CI configuration or package.json. Understand the differences between the ruby based markdownlint and the node based alternatives (markdownlint cli or markdownlint cli2). Check the status of issue #7906 to see if it has been resolved; if not, note that it needs to be addressed first. Review existing linting tests to ensure the new tool produces identical results. Relevant files include .github/workflows/ci.yml, Makefile, and any configuration files for markdownlint.