bazelbuild/bazel

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

Open

#11 405 ouverte le 15 mai 2020

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Java (4 465 forks)batch import
P3help wantedteam-Documentationtype: documentation (cleanup)

Métriques du dépôt

Stars
 (25 384 stars)
Métriques de merge PR
 (Merge moyen 22j 20h) (77 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Localisez la commande sed dans site/jekyll tree.sh qui remplace .md par .html. Ajoutez une condition pour ignorer les liens qui doivent rester en .md (par exemple, ceux pointant vers des fichiers bruts GitHub ou du markdown externe) en vérifiant le modèle de la cible du lien.
Stack technique
shell
Domaine
documentation
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75