跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

更新日志

最后更新 查看 MarkdownAgent 设置

更新日志记录产品中值得注意、带日期的变更。语气为指导性、直截了当。

本页说明如何编写更新日志。要查看已发布的更新本身,请参考更新日志。

何时使用

当你需要将产品中值得注意、带日期的变更记录为持续更新的信息流时,请编写更新日志。它不是:

  • 博客文章。 更新日志条目是对一次变更的简短事实记录,而博客文章会用较长篇幅解释和推广。
  • 对变更本身的文档。 条目记录发生了什么变化并给出外链,而真正说明该变更的是如何操作、参考或概念页面。

完整比较请参阅内容类型。

标题与描述

  • 标题:页面标题为 Changelog。
  • 描述:点出产品以及更新日志所跟踪的内容,例如近期变更、新功能和缺陷修复。

搭建此页面

使用 Nimbus changelog 模板生成此页面。你的编程代理会获取完整页面框架和自查清单,然后根据你的产品进行调整:

npx @cloudflare/nimbus-docs add content-changelog

将模板生成的 frontmatter 调整为 Cloudflare 的 schema:设置 pcx_content_type 和 products,替代模板生成的 type 等通用字段。

组件指引

  • ProductChangelog 会在更新日志页面渲染某产品的条目,从条目文件夹拉取内容,以便新增条目时页面保持最新。
  • 条目 构成正文:changelog 集合中每个带日期的 MDX 文件对应一次值得注意的变更,各自有标题、描述和日期。
  • 不适合放入的内容: 长篇解释或推广。条目应简短、基于事实,并链接到深入说明该变更的如何操作或概念页面。

Frontmatter

pcx_content_type: changelog
products:
  - product-a
  - product-b

欲了解更多详情,请参考 pcx_content_type。

所有权

产品经理和工程师会手动或通过其团队拥有的自动化流程来维护更新日志。PCX 提供审核,但不负责创建或编写更新日志。

构建更新日志

更新日志需要一个 MDX 页面文件以及一个相应的更新日志条目文件夹。这些文件的组合使我们能够:

更新日志页面

MDX 页面需要若干特殊值来引入更新日志信息,这些值已在示例页面中突出显示。有关 ProductChangelog 组件的更多信息,请参考 ProductChangelog。

/src/content/docs/dns/changelog.mdxmdx
---
pcx_content_type: changelog
products:
  - dns
title: Changelog
description: Track recent changes, new features, and bug fixes for Cloudflare DNS.
---

import { ProductChangelog } from "~/components";

{/* <!-- Actual content lives in /src/content/changelog/dns/. --> */}

<ProductChangelog product="dns" />

更新日志条目

更新日志条目保存在我们文档的另一个位置:/src/content/changelog/ ↗。每个条目都是其自身的 MDX 文件,类似于以下内容。

src/content/changelog/dns/mdx
---
title: Account-level DNS analytics now available via GraphQL Analytics API
description: Authoritative DNS analytics can now be accessed on the account level via the GraphQL Analytics API.
products:
  - dns
date: 2025-06-19
---

Authoritative DNS analytics are now available on the **account level** via the [Cloudflare GraphQL Analytics API](/analytics/graphql-api/).

This allows users to query DNS analytics across multiple zones in their account, by using the `accounts` filter.

Here is an example to retrieve all DNS queries across all zones in an account that resulted in an `NXDOMAIN` response over a given time frame. Please replace `a30f822fcd7c401984bf85d8f2a5111c` with your actual account ID.

```graphql graphql-api-explorer title="GraphQL example for account-level DNS analytics"
query Viewer {
	viewer {
		accounts(filter: { accountTag: "a30f822fcd7c401984bf85d8f2a5111c" }) {
			dnsAnalyticsAdaptive(
				limit: 10
				filter: {
					date_geq: "2025-06-16"
					responseCode: "NXDOMAIN"
					date_leq: "2025-06-18"
				}
				orderBy: [datetime_DESC]
			) {
				zoneTag
				queryName
				responseCode
				queryType
				datetime
			}
		}
	}
}
```

To learn more and get started, refer to the [DNS Analytics documentation](/dns/additional-options/analytics/#analytics).

条目属性

每个更新日志条目都具有以下属性:

  • title stringrequired

    • 显示在标题标头和社交媒体嵌入中。
  • description stringrequired

    • 显示在社交媒体嵌入中。
  • date daterequired

    • 这应当是一个格式为 YYYY-MM-DD 的日期。例如,2025-02-04。
  • products Array<String>(default: current location) required

    • 产品列表区分大小写。只能使用小写。

    • 这应当是一个字符串数组,每个字符串均指向产品集合中某文件的名称(不带文件扩展名)。

    • 您的条目所在的文件夹(例如 src/content/changelog/workers/2025-02-13-new-product-feature.mdx)将被推断为此属性的一部分。如果您不想将该条目与其他产品相关联,则可以完全从 frontmatter 中省略它。

    • 如果您希望引用不在此集合中的产品,例如存在于现有产品的子路径中的产品,您可以创建一个“仅元数据”的条目:

      src/content/products/workers-observability.yamlyaml
      name: Workers Observability
      
      product:
      	title: Workers Observability
      	url: /workers/observability/
      	group: Developer platform
      	show: false
  • hidden Boolean(default: false) optional

    • 如果为 true,此页面将可以通过直接链接访问,但会在主 更新日志 页面和所有 RSS 订阅源中隐藏。
    • 如果为 true,还将添加 noindex 属性,以便搜索引擎爬虫不会对页面进行索引。

面向 AI 和智能体编写

  • 带日期的原子条目。 为每次变更提供独立的带日期条目,并包含标题和描述,因为智能体按条目提取和排序变更,而不是扫描正文。
  • 字面日期和产品名。 在 frontmatter 中使用 YYYY-MM-DD 日期和准确的产品名称,以便读者或智能体可靠地筛选和排序信息流。
  • 深入内容用外链。 条目只写变更本身,并链接到解释它的如何操作或概念页面,因为更新日志记录的是改了什么,而不是如何使用。

这篇文档对您有帮助吗?