为 Azure Linux 文档做贡献

本文介绍了如何通过修复错误、改进指南或添加新内容来帮助用户在 Azure 上运行 Azure Linux 并提供受支持的 Azure Linux 方案指南，从而为 Azure Linux 文档做出贡献。

Note

Azure Linux 4.0 现在位于 preview 中，严格限制为评估和测试目的。 它不适合生产用途。

范围内的文档贡献

Azure Linux 文档仅介绍Azure方案，这符合Microsoft的支持和生命周期承诺。 我们维护和接受有助于人们在 Azure 上使用 Azure Linux 的内容的贡献，具体而言：

  • Azure Linux 虚拟机（VM）/虚拟机规模集（VMSS）、AKS 和容器映像指南。
  • 基于预构建的 Azure Linux 映像进行的自定义（例如，使用 映像自定义器）。

如果看到差距、错误或改进以Azure为中心的指导的机会，请与我们分享。

范围外文档贡献

若要使文档保持专注且可维护，将关闭以下类型的贡献：

  • 适用于 Microsoft 支持和生命周期承诺范围之外的场景的内容，包括裸机、ISO 映像、本地部署、其他云，或基于 GitHub 上的 Azure Linux 源代码 从头构建的映像。
  • 重复的内容 ，该内容会重述另一页中已存在的内容，而无需添加新值。
  • 宣传性或特定厂商的内容，突出宣传 Azure Linux 生态系统之外的特定产品、工具或服务。
  • 推测性或未经验证的指导，尚未在受支持的 Azure Linux 配置上经过测试。
  • 未经事先发布和维护者批准而主动提交的大量重写。

样式和格式设置指南

Azure Linux 文档遵循 Microsoft Learn 文档样式指南。 所有贡献都应符合这些标准。 不遵循这些约定的拉取请求 (PR) 可能会在开始评审之前被退回修改。

提交文档更改

Important

所有文档贡献都需要先提交一个议题。 如果没有关联的问题，请不要打开 PR。 未关联议题的 PR 可能会在未经审核的情况下被关闭。

提交文档更改的步骤：

  1. 提出问题。 描述差距、错误或改进机会。 尽可能具有描述性;包括Azure服务、Azure Linux 版本、工作负荷类型以及任何相关的上下文或复制步骤。 等待维护者在开始工作之前确认问题。
  2. 搜索重复项。 在提交之前，请检查现有问题和 PR 以避免重复工作。
  3. 复刻和分支。 维护人员确认问题后，创建存储库的个人分支和具有描述性名称的分支（例如， fix/aks-quickstart-typo 或 docs/selinux-recipe）。
  4. 提交 PR。 在 PR 描述中附上已获批准的议题链接。 保持修改简洁，并以任务为导向。 包括上下文，例如Azure服务、Azure Linux 版本和工作负载类型，以便审阅者可以评估你的贡献。
  5. 等待评审。 维护者将查看你的 PR。 如果请求，请准备好进行更改。 并非所有 PR 都能保证被合并。

提交 PR 后的预期内容

  • 评论是尽力而为。 维护人员在容量允许时审查贡献。 响应时间可能会有所不同，并且社区 PR 上没有保证的服务级别协议（SLA）。
  • 并非所有贡献都将合并。 如果 PR 超出 Azure 支持范围、与现有内容重复，或与文档方向不一致，则可能会被关闭。
  • 系统可能会要求你修改。 审阅者可以请求对范围、准确性或格式的更改，然后才能批准 PR。
  • 问题可能会在未采取任何操作的情况下被关闭。 如果问题信息不完整、超出范围，或在 30 天后仍无任何活动，则该问题可能会被关闭。
  • 长期无更新的 PR 将被关闭。 30 天内没有活动的 PR 可能会被自动关闭。 如果要继续处理 PR，可以重新打开。

相关内容

有关参与 Azure Linux 的详细信息，请参阅 如何参与 Azure Linux。

  • Last updated on