Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

Changelog

最終更新 Markdown で表示Agent セットアップ

Changelog は、製品の注目すべき日付付きの変更を記録します。トーンは手順を示しつつ、率直にします。

このページでは書き方を説明します。公開済みの更新そのものは Changelog を参照してください。

使うタイミング

製品の注目すべき日付付きの変更を、継続的なフィードとして記録するときに Changelog を書きます。次のものではありません。

  • ブログ記事。 Changelog のエントリは 1 件の変更の短い事実記録です。ブログ記事は長く説明し、宣伝します。
  • 変更そのもののドキュメント。 エントリは何かが変わったことを記録してリンクします。変更の実体は how-to、リファレンス、またはコンセプト側で説明します。

全体の比較は コンテンツタイプ を参照してください。

タイトルと説明

  • タイトル: ページタイトルは Changelog です。
  • 説明: 製品名と、Changelog が追跡する内容（最近の変更、新機能、バグ修正など）を書きます。

このページのひな形

Nimbus の changelog レシピを使って、このページを生成します。コーディングエージェントがページのひな形と自己レビュー用チェックリストを取得し、製品に合わせて調整します。

npx @cloudflare/nimbus-docs add content-changelog

レシピが出力する frontmatter を Cloudflare のスキーマに合わせて調整します。レシピが出力する type などの汎用フィールドではなく、pcx_content_type と products を設定します。

コンポーネントの指針

  • ProductChangelog は Changelog ページに製品のエントリを描画します。entries フォルダから取り込むため、エントリを追加してもページは最新のままです。
  • Entries（エントリ） が本文です。changelog コレクション内の日付付き MDX ファイルが、それぞれ 1 件の注目すべき変更であり、独自の title、description、date を持ちます。
  • 向かないもの: 長文の説明や宣伝。エントリは短く事実だけにし、変更を詳しく扱う how-to またはコンセプトへリンクします。

frontmatter

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

詳細は pcx_content_type を参照してください。

担当

プロダクトマネージャーとエンジニアが、手動またはチームが運用する自動化プロセスで Changelog を維持します。PCX はレビューを行いますが、Changelog の作成や執筆は担当しません。

Changelog を組み立てる

Changelog には MDX のページファイルと、対応する Changelog エントリのフォルダが必要です。これらのファイルを組み合わせると、次ができます。

Changelog ページ

MDX ページには、Changelog 情報を取り込むための特別な値がいくつか必要です。サンプルページで強調しています。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" />

Changelog エントリ

Changelog エントリは、ドキュメントの別の場所 /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).

エントリのプロパティ

各 Changelog エントリには、次のプロパティがあります。

  • title string required

    • タイトル見出しと、ソーシャルメディアの埋め込みに表示されます。

  • description string required

    • ソーシャルメディアの埋め込みに表示されます。

  • date date required

    • YYYY-MM-DD 形式の日付にします。例: 2025-02-04。

  • products Array<String> (default: current location) required

    • products のリストは大文字と小文字を区別します。小文字だけを使います。

    • 文字列の配列にします。各要素は products コレクション内のファイル名（拡張子なし）を指します。

    • エントリがあるフォルダ（例: 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 の場合、直接リンクではアクセスできますが、メインの changelog ページとすべての RSS フィードからは非表示になります。
    • true の場合、検索クローラーにインデックスされないよう noindex プロパティも追加されます。

AI とエージェント向けの書き方

  • 日付付きで、1 件ずつ独立したエントリ。 各変更に、タイトルと説明付きの日付付きエントリを 1 件ずつ付けます。エージェントは本文を走査するのではなく、エントリ単位で変更を抽出して並べます。
  • リテラルな日付と製品。 frontmatter では YYYY-MM-DD の日付と正確な製品名を使います。読者やエージェントがフィードを確実に絞り込んで並べ替えられます。
  • 詳細はリンクする。 エントリは変更そのものに留め、説明する how-to またはコンセプトへリンクします。Changelog は何が変わったかを記録し、使い方は記録しません。

役に立ちましたか？