istio/istio.io

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

Open

#15,148 opened on May 20, 2024

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

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

Tech stack
nodejs
Domain
developer experienceci cd
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
mostly clear
Prerequisites
Resolution of issue #7906Familiarity with Node.jsUnderstanding of markdownlintExperience with CI configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
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.