提交博客文章和案例研究

任何人都可以撰写博客文章并提交以供审核。案例研究需要经过广泛审核才能获得批准。

Kubernetes 博客

Kubernetes 博客用于项目沟通新功能、社区报告以及可能与 Kubernetes 社区相关的任何新闻。这包括最终用户和开发人员。博客的大部分内容都与核心项目中发生的事情有关，但我们鼓励您提交有关生态系统中其他地方发生的事情的博客文章！

任何人都可以撰写博客文章并提交以供审核。

提交文章

博客文章不应具有商业性质，应包含广泛适用于 Kubernetes 社区的原创内容。合适的博客内容包括

  • 新的 Kubernetes 功能
  • Kubernetes 项目更新
  • 来自特别兴趣小组的更新
  • 教程和演练
  • 关于 Kubernetes 的思想领导力
  • Kubernetes 合作伙伴 OSS 集成
  • 仅原创内容

不合适的內容包括

  • 供应商产品推销
  • 没有集成和客户案例的合作伙伴更新
  • 联合发布的文章（语言翻译可以）

要提交博客文章，请按照以下步骤操作

  1. 签署 CLA（如果您尚未签署）。

  2. 查看 网站存储库 中现有博客文章的 Markdown 格式。

  3. 在您选择的文本编辑器中撰写您的博客文章。

  4. 在步骤 2 中相同的链接上，单击“创建新文件”按钮。将您的内容粘贴到编辑器中。将文件命名为与博客文章的建议标题相匹配，但不要在文件名中添加日期。博客评论者会与您协商最终文件名和博客发布的日期。

  5. 保存文件后，GitHub 会引导您完成拉取请求流程。

  6. 博客文章评论者将审查您的提交，并就反馈和最终细节与您合作。博客文章获得批准后，将安排博客发布。

指南和期望

  • 博客文章不应是供应商推销。

    • 文章必须包含广泛适用于 Kubernetes 社区的内容。例如，提交应侧重于上游 Kubernetes，而不是供应商特定的配置。查看 文档风格指南 以了解 Kubernetes 属性通常允许的内容。
    • 链接应主要指向官方 Kubernetes 文档。使用外部参考时，链接应多样化 - 例如，提交不应仅包含指向单个公司的博客的链接。
    • 有时这是一个微妙的平衡。博客团队 会提供指导，判断文章是否适合 Kubernetes 博客，因此请随时与他们联系。

  • 博客文章不会在特定日期发布。

    • 文章由社区志愿者审核。我们会尽力满足特定的时间安排，但我们不作任何保证。
    • Kubernetes 项目的许多核心部分在发布窗口期间提交博客文章，从而延迟了发布时间。考虑在发布周期比较安静的时候提交文章。
    • 如果您希望在发布日期方面进行更多协调，与 CNCF 营销团队 协调比提交博客文章更合适。
    • 有时审核会积压。如果您觉得您的审核没有得到应有的关注，您可以联系 #sig-docs-blog Slack 频道 上的博客团队，实时询问。

  • 博客文章应与 Kubernetes 用户相关。

    • 与 Kubernetes SIG 活动的参与或结果相关的主题始终是主题（请参阅 贡献者通信团队 中的工作，以获取有关这些文章的支持）。
    • Kubernetes 的组件是刻意模块化的，因此使用现有集成点（如 CNI 和 CSI）的工具是主题。
    • 关于其他 CNCF 项目的文章可能是也可能不是主题。我们建议您在提交草稿之前咨询博客团队。
      • 许多 CNCF 项目都有自己的博客。这些通常是发布文章的更好选择。CNCF 项目在重大功能或里程碑方面，用户可能希望在 Kubernetes 博客上阅读。
    • 关于为 Kubernetes 项目做出贡献的博客文章应发布在 Kubernetes 贡献者网站 上。

  • 博客文章应为原创内容

    • 官方博客不适合将来自第三方的现有内容重新用于新内容。
    • 博客的 许可 允许将内容用于商业目的，但反之则不行。

  • 博客文章的目标应该是面向未来的

    • 鉴于项目的开发速度，我们希望能够提供常青内容，这些内容不需要更新以保持准确性，以便读者了解。
    • 将教程或更新官方文档作为博客文章，可能比撰写高级概述更合适。
      • 考虑将较长的技术内容作为博客文章的号召性用语，并将重点放在问题空间或读者为什么要关注这个问题上。

提交博客文章的技术注意事项

提交必须以 Markdown 格式，才能被 Hugo 博客生成器使用。关于如何使用此技术堆栈，有 大量资源可用。

对于插图、图表或表格，可以使用 figure shortcode。对于其他图像，我们强烈建议使用 alt 属性；如果图像不需要任何 alt 属性，那么它可能根本不需要出现在文章中。

我们认识到，此要求会让不太熟悉的人更难以提交文章，我们一直在寻找降低这方面门槛的解决方案。如果您对如何降低门槛有想法，请自愿帮忙。

SIG 文档的 博客子项目 管理博客文章的审核流程。有关更多信息，请参阅 提交文章。

要提交博客文章，请按照以下说明操作

  • 使用新的博客文章 打开拉取请求。新的博客文章位于 content/en/blog/_posts 目录下。

  • 确保您的博客文章遵循正确的命名约定以及以下 frontmatter（元数据）信息

    • Markdown 文件名必须遵循 YYYY-MM-DD-Your-Title-Here.md 格式。例如，2020-02-07-Deploying-External-OpenStack-Cloud-Provider-With-Kubeadm.md。

    • 不要在文件名中包含点。例如，2020-01-01-whats-new-in-1.19.md 这样的名称会导致构建失败。

    • frontmatter 必须包含以下内容

      ---
layout: blog
title: "Your Title Here"
date: YYYY-MM-DD
slug: text-for-URL-link-here-no-spaces
---

    • 第一个或初始提交消息应简要概述正在完成的工作，并应作为博客文章的描述独立存在。请注意，对您博客的后续编辑将合并到此主要提交中，因此它应尽可能有用。

      • 良好的提交消息示例
        • 添加关于 foo Kubernetes 功能的博客文章
        • 博客：foobar 公告
      • 不良的提交消息示例
        • 添加博客文章
        • .
        • 初始提交
        • 草稿文章

    • 然后，博客团队将审核您的 PR，并就您可能需要修复的问题提供评论。之后，机器人将合并您的 PR，您的博客文章将发布。

    • 如果博客文章的内容仅包含不需要更新以保持准确性以供读者理解的内容，则可以将其标记为常青内容，并免除向超过一年的博客文章添加有关过时内容的自动警告。

      • 要将博客文章标记为常青内容，请在 frontmatter 中添加以下内容

        evergreen: true

      • 不应标记为常青内容的内容示例

        • 教程，这些教程仅适用于特定版本或版本，而不适用于所有将来的版本
        • 对预发布 API 或功能的引用

从 Kubernetes 贡献者博客镜像

要从 Kubernetes 贡献者博客 镜像博客文章，请遵循以下指南

  • 保持博客内容相同。如果有更改，应先对原始文章进行更改，然后再对镜像文章进行更改。
  • 镜像博客应具有 canonicalUrl，即原始博客发布后，其本质上是原始博客的 url。
  • Kubernetes 贡献者博客 会在其 YAML 标头中提及其作者，而 Kubernetes 博客文章会在博客内容本身中提及作者。镜像内容时，应更改此内容。
  • 发布日期保持与原始博客相同。

上述所有其他指南和期望也适用。

提交案例研究

案例研究重点介绍组织如何使用 Kubernetes 来解决现实世界中的问题。Kubernetes 营销团队和 CNCF 的成员会与您合作完成所有案例研究。

查看 现有案例研究 的源代码。

参考 案例研究指南，并按照指南中的说明提交您的请求。

上次修改时间：2024 年 2 月 16 日下午 12:04 PST：添加镜像指南 (d2c156ccce)