提交博客文章和案例研究

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

Kubernetes 博客

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

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

提交文章

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

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

不合适的内容包括

  • 供应商产品宣传
  • 没有集成和客户案例的合作伙伴更新
  • 转载的文章（语言翻译是可以的）

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

  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 短代码。对于其他图像，我们强烈建议使用 alt 属性；如果图像不需要任何 alt 属性，则可能根本不需要在文章中使用它。

我们认识到，这一要求使得不太熟悉的人更难提交内容，我们一直在寻找降低门槛的解决方案。如果您对如何降低门槛有任何想法，请自愿提供帮助。

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

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

  • 发起拉取请求，其中包含一篇新的博客文章。新的博客文章位于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 公告
      • 糟糕的提交消息示例
        • 添加博客文章
        • .
        • 初始提交
        • 文章草稿

    • 然后，博客团队将审阅您的拉取请求，并就您可能需要修复的问题给出意见。之后，机器人将合并您的拉取请求，您的博客文章将被发布。

    • 如果博客文章的内容仅包含预计不需要更新即可保持准确性的内容，则可以将其标记为常青内容，并免于自动添加的关于一年以上旧博客文章已过时的警告。

      • 要将博客文章标记为常青内容，请将其添加到前言中

        evergreen: true

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

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

从 Kubernetes 贡献者博客镜像

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

  • 保持博客内容不变。如果有任何更改，应先对原文进行更改，然后再对镜像文章进行更改。
  • 镜像博客应具有 canonicalUrl，即发布后的原始博客网址。
  • Kubernetes 贡献者博客 在 YAML 标题中提及作者，而 Kubernetes 博客文章在博客内容本身中提及作者。镜像内容时应更改这一点。
  • 发布日期与原始博客相同。

上述所有其他准则和期望也适用。

提交案例研究

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

查看 现有案例研究 的来源。

请参阅 案例研究指南，并按照指南中的概述提交您的请求。

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