istio/istio.io

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

Open

#15,148 opened on May 20, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)HTML (1,492 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (740 stars)
PR merge metrics
 (Avg merge 9d 10h) (47 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Replace the current ruby based markdownlint with a node based one (e.g., markdownlint cli2), update package.json scripts, and verify the documentation repo passes all markdown linting tests. Ensure any custom rules or configurations are migrated correctly.
Tech stack
nodejs
Domain
documentationbuild system
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.jsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70