博客

了解如何提交博客文章。

OpenTelemetry 博客用于发布新功能、社区报告以及任何可能与 OpenTelemetry 社区相关的新闻。这包括最终用户和开发人员。任何人都可以撰写博客文章,请阅读下面的要求。

文档还是博客文章?

在撰写博客文章之前,请问问自己,您的内容是否也可能对文档有所补充。如果答案是“是”,请创建一个新的问题或拉取请求 (PR) 并附上您的内容,以便将其添加到文档中。

请注意,OpenTelemetry 网站维护者和审批者的重点是改进项目的文档,因此您的博客文章的审阅优先级会较低。

社交媒体内容请求

如果您想请求在 OpenTelemetry 项目的社交媒体频道上发布内容(非博客文章),请使用此表单

在提交博客文章之前

博客文章不应具有商业性质,并且应包含适用于 OpenTelemetry 社区的原创内容。博客文章应遵循社交媒体指南中概述的政策。

链接到 GitHub 存储库

在链接到 GitHub 存储库中的源代码时,请勿链接到 main(或其他默认)分支。而是链接到撰写博客文章时代码状态的**特定提交**或**标记版本**。

这样可以确保博客文章保持稳定,并且不会随着存储库的演变而在未来失效。

验证您打算发布的内容是否广泛适用于 OpenTelemetry 社区。合适的内容包括:

  • 新的 OpenTelemetry 功能
  • OpenTelemetry 项目更新
  • 特别兴趣小组 (SIG) 的更新
  • 教程和演练
  • OpenTelemetry 集成
  • 招募贡献者

不合适的内容包括:

  • 供应商产品推广

如果您的博客文章符合合适内容列表,请提出一个问题并提供以下详细信息:

  • 博客文章的标题
  • 博客文章的简短描述和概要
  • 如果适用,请列出博客文章中使用的技术。请确保所有技术都是开源的,并且优先选择 CNCF 项目而不是非 CNCF 项目(例如,使用 Jaeger 进行跟踪可视化,使用 Prometheus 进行指标可视化)。
  • 与此博客文章相关的SIG的名称
  • 来自该 SIG 的赞助商(维护者或审批者)的姓名,他们将协助审阅该 PR。该赞助商最好来自不同的公司。

SIG 沟通维护者将验证您的博客文章是否满足所有接受要求。如果您无法在初始问题详情中命名 SIG/赞助商,他们也将为您指出可以联系的合适 SIG 以获得赞助。拥有赞助商是可选的,但拥有赞助商会增加您的博客文章更快获得审阅和批准的机会。

如果您的问题包含所有必需信息,维护者将验证您可以继续提交博客文章。

招募贡献者

如果您提议创建一个新项目或 SIG,或者您正在向 OpenTelemetry 项目捐赠,您将需要额外的贡献者来使您的提案获得成功。为了帮助您,您可以提议一篇“招募贡献者”(CfC) 的博客文章。

这要求您遵循新项目捐赠的流程。

提交博客文章

您可以通过 Fork 本仓库并本地编写,或者通过 GitHub UI 提交博客文章。在这两种情况下,我们都要求您遵循博客文章模板提供的说明。

Fork 并本地编写

设置好本地 Fork 后,您可以使用模板创建博客文章。请按照以下步骤从模板创建帖子:

  1. 从仓库根目录运行以下命令:

    npx hugo new content/en/blog/$(date +%Y)/short-name-for-post.md
    

    如果您的帖子包含图像或其他资产,请运行以下命令:

    npx hugo new content/en/blog/$(date +%Y)/short-name-for-post/index.md
    
  2. 编辑上一个命令中提供的路径下的 Markdown 文件。该文件是从 archetypes下的博客文章入门模板初始化的。

  3. 将图像或其他文件等资产放入您创建的文件夹中。

  4. 帖子准备好后,通过拉取请求提交。

使用 GitHub UI

如果您不想创建本地 Fork,可以使用 GitHub UI 创建新帖子。请按照以下步骤通过 UI 添加帖子:

  1. 转到博客文章模板,然后在菜单的右上角点击**复制原始内容**。

  2. 选择创建新文件

  3. 将您在第一步中复制的模板内容粘贴进来。

  4. 为您的文件命名,例如(YYYY 是当前年份):

    content/blog/YYYY/short-name-for-your-blog-post/index.md.

  5. 在 GitHub 中编辑 Markdown 文件。

  6. 帖子准备好后,选择**提议更改**并按照说明进行操作。

发布时间表

OpenTelemetry 博客不遵循严格的发布时间表,这意味着:

  • 您的博客文章将在获得所有必需的批准后发布。
  • 可以根据需要推迟发布,但维护者无法保证在特定日期或之前发布。
  • 某些博客文章(重大公告)具有优先权,可能会在您的博客文章之前发布。

博客内容交叉发布

如果您想在其他平台分享您的 OpenTelemetry 博客文章,欢迎这样做。请注意以下事项:

  • 确定哪个版本将是原始文章(通常是 OpenTelemetry 博客上的原创文章)。
  • 其他版本的文章应:
    • 明确提及原始文章出现在 OpenTelemetry 博客上。
    • 在页面顶部或底部包含指向原始文章的链接。
    • 设置一个指向 OpenTelemetry 博客文章的规范 URL 标签(canonical URL tag),如果平台支持的话。

这有助于确保正确归属,支持 SEO 最佳实践,并避免内容重复。