bazelbuild/bazel

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

Open

#11.405 aberto em 15 de mai. de 2020

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Java (4.465 forks)batch import
P3help wantedteam-Documentationtype: documentation (cleanup)

Métricas do repositório

Stars
 (25.384 stars)
Métricas de merge de PR
 (Mesclagem média 22d 20h) (77 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Localize o comando sed em site/jekyll tree.sh que substitui .md por .html. Adicione uma condição para pular links que devem permanecer como .md (por exemplo, aqueles que apontam para arquivos raw do GitHub ou markdown externo) verificando o padrão do destino do link.
Pilha de tecnologia
shell
Domain
documentation
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75