为 minikube 文档做贡献

minikube 的文档使用 Markdown 编写,并使用以下工具生成:

在生产环境中,minikube 网站使用 Netlify 进行托管。

小的或格式上的贡献

请参考 Kubernetes 关于文档贡献的通用指南,使用 GitHub 的仓库和 Markdown 编辑器进行贡献。

本地文档网站

要本地运行文档网站,请克隆 minikube 仓库并运行:

make site

注意事项

  • 在 GNU/Linux 上,发行版自带的 golang 包可能不够新。请使用最新版本。
  • 在 Windows 上,我们当前的网站会导致 Hugo panic

Lint

我们推荐安装 markdownlint 来查找 Markdown 文件中的问题。安装后,您可以使用这个方便的目标:

make mdlint

风格指南

我们遵循 Kubernetes 文档风格指南

文档间链接

要进行编译时的链接检查,请使用以下任一形式来链接文档页面:

{{< ref "document.md" >}}
{{< ref "#anchor" >}}
{{< ref "document.md#anchor" >}}
{{< ref "/blog/my-post" >}}
{{< ref "/blog/my-post.md" >}}
{{< relref "document.md" >}}
{{< relref "#anchor" >}}
{{< relref "document.md#anchor" >}}

有关更多信息,请参阅 Hugo:链接和交叉引用

Pull Request 预览

在审查文档 PR 时,请查找显示以下内容的测试:

✓ deploy/netlify Deploy preview ready! Details

Details 链接将指向一个形式如下的站点预览 URL:

https://deploy-preview-PR#--kubernetes-sigs-minikube.netlify.com


最后修改于 2022 年 4 月 25 日:Fix GitHub word for document (892cb035d)