对 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:链接和交叉引用

拉取请求预览

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

✓ deploy/netlify 部署预览已就绪!详情

详情 链接将指向一个网站预览 URL,格式如下:

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


最后修改于 2022 年 4 月 25 日:修正文档中的 GitHub 单词 (892cb035d)