istio/istio.io

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

Open

#15,148 opened on 2024年5月20日

GitHub で見る
 (6 comments) (0 reactions) (0 assignees)HTML (740 stars) (1,492 forks)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
Issue 種別
refactor
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.