istio/istio.io

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

Aperta

#15.148 aperta il 20 mag 2024

Vedi su GitHubGuida contributor
 (8 commenti) (0 reazioni) (0 assegnatari)HTML (1492 fork)batch import
good first issuehelp wanted

Metriche repository

Star
 (740 stelle)
Metriche merge PR
 (Merge medio 9g 10h) (47 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Indaga la configurazione attuale di markdownlint nel repository istio.io, probabilmente nella configurazione CI o in package.json. Comprendi le differenze tra markdownlint basato su ruby e le alternative basate su node (markdownlint cli o markdownlint cli2). Controlla lo stato dell'issue #7906 per vedere se è stata risolta; in caso contrario, nota che deve essere affrontata per prima. Rivedi i test di linting esistenti per garantire che il nuovo strumento produca risultati identici. I file rilevanti includono .github/workflows/ci.yml, Makefile e qualsiasi file di configurazione per markdownlint.
Tech stack
nodejs
Dominio
documentationbuild system
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Node.jsnpm
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70