本地构建和服务网站

在您对我们的网站做出贡献后,请确保更改按预期呈现。为了确保您可以在本地预览更改,我们提供了可让您轻松构建和查看更改的工具。我们使用自动化测试来检查所有贡献的质量。在拉取请求 (PR) 中提交更改之前,您也应该在本地运行测试。

开始之前

为了确保您在本地运行的测试与 Istio 持续集成 (CI) 上运行的测试使用相同的版本,我们提供了一个包含所有必要工具(包括我们的站点生成器:Hugo)的 Docker 镜像。

要本地构建、测试和预览站点,您需要在您的系统上安装 Docker

预览您的更改

要预览您对站点的更改,请转到您分叉的 istio/istio.io 的根目录并运行以下命令

$ make serve

如果您的更改没有构建错误,该命令将构建站点并启动一个本地 Web 服务器来托管它。要查看站点的本地构建,请在您的 Web 浏览器中访问 https://127.0.0.1:1313

如果您需要从远程服务器构建和提供站点,您可以使用 ISTIO_SERVE_DOMAIN 提供服务器的 IP 地址或 DNS 域名,例如

$ make ISTIO_SERVE_DOMAIN=192.168.7.105 serve

此示例构建站点并启动一个 Web 服务器,该服务器在远程服务器的 192.168.7.105 IP 地址上托管站点。与之前一样,您可以连接到 http://192.168.7.105:1313 上的 Web 服务器。

测试您的更改

我们使用代码检查工具和测试来确保站点的质量基线,通过自动化检查来保证内容质量。这些检查必须通过才能批准您的贡献。请确保在通过 PR 将更改提交到存储库之前,先在本地运行检查。我们执行以下自动化检查

  • HTML 校验:确保所有链接有效以及其他检查。

  • 拼写检查:确保内容拼写正确。

  • Markdown 样式检查:确保使用的标记符合我们的 Markdown 样式规则。

要本地运行这些检查,请使用以下命令

$ make lint

如果拼写检查器报告错误,以下是最可能的原因

  • 真实的拼写错误:修复 Markdown 文件中的拼写错误。

  • 错误是针对命令、字段或符号名称报告的:使用 `反引号` 将错误内容括起来。

  • 错误是针对工具词典中不存在的正确单词或专有名词报告的:将单词添加到 istio/istio.io 存储库根目录下的 .spelling 文件中。

由于网络连接不佳,您可能会遇到链接检查器问题。如果您无法获得良好的连接,您可以设置检查器以防止其检查外部链接。在运行代码检查工具时,将 INTERNAL_ONLY 环境变量设置为 True,例如

$ make INTERNAL_ONLY=True lint

当您的内容通过所有检查后,请通过 PR 提交到存储库。访问 使用 GitHub 获取更多信息。

此信息是否有用?
您是否有任何改进建议?

感谢您的反馈!