bazelbuild/bazel

Bazel docs infra: stop naively converting all markdown links to html

Open

#11.405 aperta il 15 mag 2020

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Java (4465 fork)batch import
P3help wantedteam-Documentationtype: documentation (cleanup)

Metriche repository

Star
 (25.384 star)
Metriche merge PR
 (Merge medio 22g 20h) (77 PR mergiate in 30 g)

Descrizione

The jekyll build script below naively converts all .md links in the doc site to .html. This is desirable for most links since the doc site uses .html in URLs, but it has caused problems when the intention is to keep the .md extension. For example, when linking directly to markdown files on GitHub.

https://github.com/bazelbuild/bazel/blob/357282fa857a007555ae053afc827283a3e402d6/site/jekyll-tree.sh#L104-L111

Guida contributor

Direzione di ricerca
Trova il comando sed in site/jekyll tree.sh che sostituisce .md con .html. Aggiungi una condizione per saltare i link che devono rimanere come .md (ad esempio, quelli che puntano a file raw di GitHub o markdown esterni) controllando il pattern del target del link.
Tech stack
shell
Dominio
documentation
Tipo issue
Bug
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75