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