bazelbuild/bazel

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

Open

#11,405 创建于 2020年5月15日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Java (4,465 fork)batch import
P3help wantedteam-Documentationtype: documentation (cleanup)

仓库指标

Star
 (25,384 star)
PR 合并指标
 (平均合并 22天 20小时) (30 天内合并 77 个 PR)

描述

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

贡献者指南

研究方向
找到 site/jekyll tree.sh 中将 .md 替换为 .html 的 sed 命令。添加一个条件，跳过那些旨在保持为 .md 的链接（例如指向 GitHub 原始文件或外部 markdown 的链接），通过检查链接目标模式。
技术栈
shell
领域
documentation
议题类型
缺陷
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Git
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75