为 minikube 文档做贡献

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

在生产环境中,minikube 网站使用 Netlify 提供服务

小的或外观上的贡献

使用 GitHub 的存储库和 Markdown 编辑器,如 Kubernetes 的文档贡献通用指南中所述

本地文档网站

要在本地提供文档页面,请克隆 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 部署预览已准备就绪!详细信息

详细信息链接将指向一个站点预览 URL,格式如下:

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


上次修改时间:2022 年 4 月 25 日:修复文档的 GitHub 单词 (892cb035d)