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.