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