提交博客文章和案例研究

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

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 生成器使用。有许多资源介绍了如何使用此技术堆栈。

对于插图、图表或图表，可以使用图短代码。对于其他图像，我们强烈建议使用 alt 属性；如果图像不需要任何 alt 属性，那么也许根本不需要在文章中使用它。

我们认识到，此要求使不太熟悉的人更难提交，并且我们正在不断寻找降低此门槛的解决方案。如果您有关于如何降低门槛的想法，请自愿提供帮助。

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

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

  • 打开一个拉取请求，其中包含新的博客文章。新的博客文章放在 content/en/blog/_posts 目录下。

  • 请确保您的博客文章遵循正确的命名规范和以下前言（元数据）信息

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

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

    • 前言必须包含以下内容

      ---
layout: blog
title: "Your Title Here"
date: YYYY-MM-DD
slug: text-for-URL-link-here-no-spaces
author: >
  Author-1 (Affiliation),
  Author-2 (Affiliation),
  Author-3 (Affiliation)  
---

    • 第一次或初始提交消息应该简短总结正在进行的工作，并且应该作为博客文章的独立描述。请注意，您对博客的后续编辑将被压缩到此主提交中，因此它应该尽可能有用。

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

    • 博客团队将审查您的 PR，并就您可能需要修复的问题提出意见。之后，机器人将合并您的 PR，您的博客文章将被发布。

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

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

        evergreen: true

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

        • 仅适用于特定版本或发行版而非所有未来版本的教程
        • 引用预 GA API 或功能

从 Kubernetes Contributor 博客镜像

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

  • 保持博客内容不变。如果有更改，应首先对原始文章进行更改，然后再对镜像文章进行更改。
  • 镜像的博客应该有一个 canonicalUrl，即原始博客发布后的 URL。
  • 与 Kubernetes 贡献者博客相同，Kubernetes 博客文章也按照新指南在 YAML 标头中提及作者。应确保这一点。
  • 发布日期与原始博客保持一致。

以上详细说明的所有其他准则和期望也适用。

提交案例研究

案例研究突出显示组织如何使用 Kubernetes 解决实际问题。Kubernetes 营销团队和 CNCF 的成员在所有案例研究中与您合作。

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

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

上次修改时间：2024 年 6 月 20 日下午 8:49 PST：更新 blogs-case-studies.md (1d493790e8)