Skip to content

Commit 701b46f

Browse files
committed
[Style guide] Remove noindex + content type updates
1 parent 9b4c4ca commit 701b46f

File tree

15 files changed

+128
-197
lines changed

15 files changed

+128
-197
lines changed

src/components/overrides/Head.astro

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import { getOgImage } from "~/util/og";
88
import type { CollectionEntry } from "astro:content";
99
1010
const DEFAULT_TITLE_DELIMITER = "|";
11-
const NOINDEX_PRODUCTS = ["email-security", "style-guide", "security"];
12-
const CHATBOT_DEPRIORITIZE_PRODUCTS = ["firewall"];
11+
const NOINDEX_PRODUCTS = ["email-security", "security"];
12+
const CHATBOT_DEPRIORITIZE_PRODUCTS = ["firewall", "style-guide"];
1313
1414
const currentSection = Astro.url.pathname.split("/")[1].replaceAll(".", "");
1515

src/content/docs/style-guide/documentation-content-strategy/content-types/3rd-party-integration-guide.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
pcx_content_type: concept
33
title: 3rd-party integration guide
4+
meta:
5+
title: Content type - 3rd-party integration guide
46
---
57

68
## Purpose
Lines changed: 84 additions & 169 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
---
22
pcx_content_type: concept
33
title: Changelog
4+
meta:
5+
title: Content type - Changelog
46
---
57

8+
import { Type, MetaInfo } from "~/components";
9+
610
## Purpose
711

8-
The purpose of a changelog is to log or record notable changes.
12+
The purpose of a changelog is to log or record notable changes, which then appear as part of the [Cloudflare changelog](/changelog/) and on product-specific changelog pages.
913

1014
## Tone
1115

@@ -21,199 +25,110 @@ For more details, refer to [`pcx_content_type`](/style-guide/frontmatter/custom-
2125

2226
## Ownership
2327

24-
Developers and engineers maintain changelogs manually or via an automated process that their team owns. PCX provides a review but should not own creating or writing changelogs.
25-
26-
The structure of the page can differ depending on the frequency or type of page.
27-
28-
:::note
28+
Product managers and engineers maintain changelogs manually or via an automated process that their team owns. PCX provides a review but should not own creating or writing changelogs.
2929

30-
Do not use the following terms: change log (two words), release notes, what's new, or README.
30+
## Structure
3131

32-
"What's New" is a specific [content type](https://www.cloudflare.com/whats-new/) for marketing communication.
33-
:::
34-
35-
## Structure (single-page)
36-
37-
When creating a changelog, you need an MDX page file and a corresponding YAML file in the [`src/content/changelogs` folder](https://github.com/cloudflare/cloudflare-docs/tree/production/src/content/changelogs).
32+
When creating a changelog, you need an MDX page file and a corresponding folder of changelog entries.
3833

3934
The combination of these files allows us to:
4035

41-
- Render traditional changelog content on an [HTML page](/stream/changelog/).
42-
- Programmatically create an [RSS feed](/stream/changelog/index.xml) with the changelog content.
36+
- Render traditional changelog content on an [HTML page](/dns/changelog/).
37+
- Programmatically create an [RSS feed](/changelog/rss/dns.xml) with the changelog content.
4338
- Pull all our changelog content into a [Cloudflare-wide changelog](/changelog/).
4439

4540
### Markdown file
4641

4742
Your Markdown file needs to have several special values to pull in the changelog information. These values are highlighted in the sample page.
4843

49-
```mdx title="/src/content/docs/queues/platform/changelog.mdx"
44+
```mdx title="/src/content/docs/dns/changelog.mdx"
5045
---
5146
pcx_content_type: changelog
5247
title: Changelog
53-
release_notes_file_name:
54-
- queues
55-
sidebar:
56-
order: 4
5748
---
5849
59-
import { ProductReleaseNotes } from "~/components";
50+
import { ProductChangelog } from "~/components";
6051
61-
{/* <!-- Actual content lives in /src/content/release-notes/queues.yaml. Update the file there for new entries to appear here. For more details, refer to https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/changelog/#yaml-file --> */}
52+
{/* <!-- Actual content lives in /src/content/changelog/dns/. --> */}
6253
63-
<ProductReleaseNotes />
54+
<ProductChangelog product="dns" />
6455
```
6556

66-
### YAML file
67-
68-
The `<ProductReleaseNotes>` component renders data that lives in a file within the [`/src/content/changelogs` folder](https://github.com/cloudflare/cloudflare-docs/tree/production/src/content/changelogs).
69-
70-
- `link` string required
71-
72-
- Relative path to the changelog page, such as `"/queues/changelog/"`.
73-
74-
- `productName` string required
75-
76-
- Product name to display on the [changelog](/changelog/) product filter list, as well as other areas of the template.
77-
78-
- `productLink` string required
79-
80-
- Link to top-level docs for your product (helpful for context if someone is landing on the top-level changelog page)
57+
### Changelog entries
8158

82-
- `productArea` string required
59+
Changelog entries live in a different location of our docs, [`/src/content/changelog/`](https://github.com/cloudflare/cloudflare-docs/tree/production/src/content/changelog).
8360

84-
- Rollup grouping to surface related products together in context.
61+
Each entry will be it's own MDX file, similar to the following.
8562

86-
- `productAreaLink` string required
87-
88-
- Rollup grouping to surface related products together in context. Helps pull together related RSS feeds.
89-
90-
- `entries` object required
91-
92-
- `publish_date` date required
93-
94-
- Date of published change, formatted as `YYYY-MM-DD`.
95-
96-
- `title` string optional
97-
98-
- Name of published change. Optional, but highly encouraged.
99-
100-
- `description` string required
101-
102-
- Markdown string that also follows YAML conventions. For multi-line strings, start the entry with `|-` and then type on an indented new line.
103-
104-
```yml title="/src/content/changelogs/queues.yaml"
63+
````mdx title="src/content/changelog/dns/"
10564
---
106-
link: "/queues/changelog/"
107-
productName: Queues
108-
productLink: "/queues/"
109-
productArea: Developer platform
110-
productAreaLink: /workers/platform/changelog/platform/
111-
entries:
112-
- publish_date: "2023-03-28"
113-
title: Consumer concurrency (enabled)
114-
description:
115-
Queue consumers will now [automatically scale up](/queues/learning/consumer-concurrency/)
116-
based on the number of messages being written to the queue. To control or limit
117-
concurrency, you can explicitly define a [`max_concurrency`](/queues/platform/configuration/#consumer)
118-
for your consumer.
119-
- publish_date: "2023-03-15"
120-
title: Consumer concurrency (upcoming)
121-
description: |-
122-
Queue consumers will soon automatically scale up concurrently as a queues' backlog grows in order to keep overall message processing latency down. Concurrency will be enabled on all existing queues by 2023-03-28.
123-
124-
**To opt-out, or to configure a fixed maximum concurrency**, set `max_concurrency = 1` in your Wrangler file or via [the queues dashboard](https://dash.cloudflare.com/?to=/:account/queues).
125-
126-
**To opt-in, you do not need to take any action**: your consumer will begin to scale out as needed to keep up with your message backlog. It will scale back down as the backlog shrinks, and/or if a consumer starts to generate a higher rate of errors. To learn more about how consumers scale, refer to the [consumer concurrency](/queues/learning/consumer-concurrency/) documentation.
127-
- publish_date: "2023-03-02"
128-
title: Explicit acknowledgement (new feature)
129-
description: |-
130-
You can now [acknowledge individual messages with a batch](/queues/learning/batching-retries/#explicit-acknowledgement) by calling `.ack()` on a message.
131-
132-
This allows you to mark a message as delivered as you process it within a batch, and avoids the entire batch from being redelivered if your consumer throws an error during batch processing. This can be particularly useful when you are calling external APIs, writing messages to a database, or otherwise performing non-idempotent actions on individual messages within a batch.
133-
- publish_date: "2023-03-01"
134-
title: Higher per-queue throughput
135-
description:
136-
The per-queue throughput limit has now been [raised to 400 messages
137-
per second](/queues/platform/limits/).
138-
- publish_date: "2022-12-12"
139-
title: Increased per-account limits
140-
description:
141-
Queues now allows developers to create up to 100 queues per account,
142-
up from the initial beta limit of 10 per account. This limit will continue to
143-
increase over time.
144-
- publish_date: "2022-12-13"
145-
title: sendBatch support
146-
description:
147-
The JavaScript API for Queue producers now includes a `sendBatch` method
148-
which supports sending up to 100 messages at a time.
149-
```
150-
65+
title: Account-level DNS analytics now available via GraphQL Analytics API
66+
description: Authoritative DNS analytics can now be accessed on the account level via the GraphQL Analytics API.
67+
date: 2025-06-19T12:00:00Z
15168
---
15269

153-
## Structure (multi-page)
154-
155-
In some cases, your changelog may have a separate page for each entry. The general structure is the same as the [single-page changelog](#structure-single-page), but with a few small differences.
156-
157-
### Markdown files
158-
159-
#### Top-level pages
160-
161-
For the top-level pages, you need the same frontmatter as the [single-page example](#markdown-file), but do not include any shortcodes in the body of the page.
162-
163-
#### Individual entries
164-
165-
For each entry page, create a regular markdown page. These do not require a separate style of page or any adjustments.
166-
167-
### YAML file
168-
169-
Each individual entry needs an abbreviated entry in the changelog `.yaml` file.
170-
171-
```yml title="/src/content/changelogs/waf.yaml"
172-
---
173-
link: "/waf/change-log/"
174-
productName: WAF
175-
productLink: "/waf/"
176-
productArea: Application security
177-
productAreaLink: /fundamentals/reference/changelog/security/
178-
entries:
179-
- publish_date: "2023-09-18"
180-
scheduled_date: "2023-09-25"
181-
individual_page: true
182-
scheduled: true
183-
link: "/waf/change-log/scheduled-changes/"
184-
- publish_date: "2023-09-18"
185-
individual_page: true
186-
link: "/waf/change-log/2023-09-18/"
70+
Authoritative DNS analytics are now available on the **account level** via the [Cloudflare GraphQL Analytics API](/analytics/graphql-api/).
71+
72+
This allows users to query DNS analytics across multiple zones in their account, by using the `accounts` filter.
73+
74+
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.
75+
76+
```graphql graphql-api-explorer title="GraphQL example for account-level DNS analytics"
77+
query Viewer {
78+
viewer {
79+
accounts(filter: { accountTag: "a30f822fcd7c401984bf85d8f2a5111c" }) {
80+
dnsAnalyticsAdaptive(
81+
limit: 10
82+
filter: {
83+
date_geq: "2025-06-16"
84+
responseCode: "NXDOMAIN"
85+
date_leq: "2025-06-18"
86+
}
87+
orderBy: [datetime_DESC]
88+
) {
89+
zoneTag
90+
queryName
91+
responseCode
92+
queryType
93+
datetime
94+
}
95+
}
96+
}
97+
}
18798
```
18899

189-
- `publish_date` date required
190-
191-
- Date when the page was published, formatted as `YYYY-MM-DD`. For pages with scheduled changes, you should update this field when adding/updating entries, so that the changelog item gets placed at the top of the changelog list (and feed). You should _not_ update this date when clearing all scheduled changes due to a release, since this change is not as relevant.
192-
193-
- `individual_page` boolean required
194-
195-
- Used to pull in the content from the page itself, as opposed to structured data in YAML.
196-
197-
- `link` string required
198-
199-
- Link to the individual page.
200-
201-
- `scheduled` boolean optional
202-
203-
- Should be included for scheduled pages. Because this component renders content on the underlying page, you should only have a) one scheduled entry per scheduled entry page and b) only a scheduled entry when the scheduled entry page has content.
204-
205-
- `scheduled_date` date required
206-
207-
- Should be included for pages with scheduled changes. Helps render the date of the upcoming change in the title, which provides more actionable information to folks scanning titles or the associated RSS feeds.
208-
209-
:::note
210-
211-
If the scheduled date gets pushed for a change, update the `publish_date` and `scheduled_date` fields of the changelog entry. This process makes sure customers will receive notifications via their RSS feeds.
212-
213-
:::
214-
215-
## Examples
216-
217-
- [Stream Changelog](/stream/changelog/)
218-
- [Pages Changelog](/pages/platform/changelog/)
219-
- [WAF Changelog](/waf/change-log/)
100+
To learn more and get started, refer to the [DNS Analytics documentation](/dns/additional-options/analytics/#analytics).
101+
````
102+
103+
#### Properties
104+
105+
Each changelog entries has the following properties:
106+
107+
- `title` <Type text="string" /> <MetaInfo text="required" />
108+
- Shown in the title heading and on social media embeds.
109+
- `description` <Type text="string" /> <MetaInfo text="required" />
110+
- Shown in social media embeds.
111+
- `date` <Type text="date" /> <MetaInfo text="required" />
112+
- This should be a date in `YYYY-MM-DD` format. For example, `2025-02-04`.
113+
- `preview_image` <Type text="string" /> <MetaInfo text="optional" />
114+
- Path to an image file
115+
- `products` <Type text="Array<String>" /> <MetaInfo text="(default: current location) optional" />
116+
117+
- The products list is case-sensitive. Only use lowercase.
118+
- This should be an array of strings, each referring to the name of a file in the products collection without the file extension.
119+
- The folder that your entry is in, such as `src/content/changelog/workers/2025-02-13-new-product-feature.mdx`, is inferred as part of this property. If you do not want to associate the entry with additional products, you can omit it from the frontmatter entirely.
120+
- If you wish to reference a product that does not exist in this collection, such as one that resides in the subpath of an existing product, you can create a "metadata only" entry:
121+
122+
```yaml title="src/content/proucts/workers-observability.yaml"
123+
name: Workers Observability
124+
125+
product:
126+
title: Workers Observability
127+
url: /workers/observability/
128+
group: Developer platform
129+
show: false
130+
```
131+
132+
- `hidden` <Type text="Boolean" /> <MetaInfo text="(default: false) optional" />
133+
- If `true`, this page will be accessible from the direct link, but hidden from the main [changelog](/changelog/) page and all RSS feeds.
134+
- If `true`, will also add a `noindex` property so the page is not indexed by search crawlers.

src/content/docs/style-guide/documentation-content-strategy/content-types/concept.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
pcx_content_type: concept
33
title: Concept
4+
meta:
5+
title: Content type - Concept
46
---
57

68
## Purpose

src/content/docs/style-guide/documentation-content-strategy/content-types/configuration.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
pcx_content_type: concept
33
title: Configuration
4-
4+
meta:
5+
title: Content type - Configuration
56
---
67

78
## Purpose
@@ -12,7 +13,7 @@ The purpose of a configuration is to show examples of specific settings, values,
1213

1314
plain, descriptive, straightforward
1415

15-
## content\_type
16+
## content_type
1617

1718
```yaml
1819
pcx_content_type: configuration

src/content/docs/style-guide/documentation-content-strategy/content-types/design-guide.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
pcx_content_type: concept
33
title: Design guide
4-
4+
meta:
5+
title: Content type - Design guide
56
---
67

78
## Purpose
@@ -12,7 +13,7 @@ Help users understand how to plan and design a solution using Cloudflare. Typica
1213

1314
instructional, straightforward
1415

15-
## content\_type
16+
## content_type
1617

1718
```yaml
1819
pcx_content_type: design-guide

src/content/docs/style-guide/documentation-content-strategy/content-types/faq.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
pcx_content_type: concept
33
title: FAQ
4+
meta:
5+
title: Content type - FAQ
46
---
57

68
## Purpose

0 commit comments

Comments
 (0)