GoogleContainerTools/skaffold

[Docs] Move all inline `skaffold.yaml` snippets to `docs/content/en/samples`

開放

#6,589 建立於 2021年9月10日

在 GitHub 查看貢獻者指南
 (4 則留言) (0 個反應) (1 位負責人)Go (1,416 個分叉)batch import
area/docsdocs-fixitgood first issuehelp wantedkind/documentationkind/todopriority/p2

倉庫指標

星標
 (12,822 顆星)
PR 合併指標
 (平均合併 3天 6小時) (30 天內合併 16 個 PR)

描述

Currently there exist skaffold config snippets strewn inline with rest of the docs. These can get stale very quickly. The correct place for these snippets is in docs/content/en/samples directory which has schema validations run as part of unit tests; and referenced in markdown using:

{{% readfile file="samples/path-to-file" %}}

This is a tracking issue to scan the docs and relocate these snippets.

貢獻者指南

研究方向
掃描 docs/content/en 目錄中內聯的 skaffold.yaml 片段，將其移動到 docs/content/en/samples 目錄並適當命名，然後用 {{% readfile file="samples/path to file" %}} 短代碼替換內聯片段。查看現有示例以了解命名約定。
技術棧
go
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
GitMarkdownYAML
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80