本仓库包含了所有用于构建 Kubernetes 网站和文档 的软件资产。 我们非常高兴您想要参与贡献!
请参考 Hugo 的官方文档了解 Hugo 的安装指令。
请确保安装的是 netlify.toml
文件中环境变量 HUGO_VERSION
所指定的
Hugo 扩展版本。
在构造网站之前,先克隆 Kubernetes website 仓库:
git clone https://github.com/kubernetes/website.git
cd website
git submodule update --init --recursive
注意: Kubernetes 网站要部署 Docsy Hugo 主题.
如果你还没有更新你本地的 website 仓库,目录 website/themes/docsy
会是空目录。
在本地没有主题副本的情况下,网站无法正常构造。
使用下面的命令更新网站主题:
git submodule update --init --recursive --depth 1
若要在本地构造和测试网站,请运行:
hugo server --buildFuture
上述命令会在端口 1313 上启动本地 Hugo 服务器。 启动浏览器,打开 http://localhost:1313 来查看网站。 当你对源文件作出修改时,Hugo 会更新网站并强制浏览器执行刷新操作。
通过 社区页面 进一步了解 SIG Docs Kubernetes 社区和会议信息。
你也可以通过以下渠道联系本项目的维护人员:
你也可以点击屏幕右上方区域的 Fork 按钮,在你自己的 GitHub 账号下创建本仓库的拷贝。此拷贝被称作 fork。 你可以在自己的拷贝中任意地修改文档,并在你已准备好将所作修改提交给我们时, 在你自己的拷贝下创建一个拉取请求(Pull Request),以便让我们知道。
一旦你创建了拉取请求,某个 Kubernetes 评审人会负责提供明确的、可执行的反馈意见。 作为拉取请求的拥有者,修改拉取请求以解决 Kubernetes 评审人所提出的反馈是你的责任。
还要提醒的一点,有时可能会有不止一个 Kubernetes 评审人为你提供反馈意见。 有时候,某个评审人的意见和另一个最初被指派的评审人的意见不同。
更进一步,在某些时候,评审人之一可能会在需要的时候请求 Kubernetes 技术评审人来执行技术评审。 评审人会尽力及时地提供反馈意见,不过具体的响应时间可能会因时而异。
有关为 Kubernetes 文档做出贡献的更多信息,请参阅:
可以通过以下方式联系中文本地化的维护人员:
- Rui Chen (GitHub - @chenrui333)
- He Xiaolong (GitHub - @markthink)
- Slack channel
参与 Kubernetes 社区受 CNCF 行为准则约束。
Kubernetes 因为社区的参与而蓬勃发展,感谢您对我们网站和文档的贡献!