Skip to content

Commit 114602a

Browse files
authored
[Docs Site] Rename changelog collection to release-notes (#19969)
* [Docs Site] Rename changelog collection to release-notes * fix redirects * assert entry is inside a product folder
1 parent 2f51bf6 commit 114602a

File tree

192 files changed

+709
-417
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

192 files changed

+709
-417
lines changed

.github/CODEOWNERS

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@
2222
/src/content/docs/workers-ai/ @rita3ko @craigsdennis @markdembo @mchenco @daisyfaithauma @cloudflare/pcx-technical-writing
2323
/src/content/docs/vectorize/ @elithrar @vy-ton @sejoker @mchenco @cloudflare/pcx-technical-writing
2424
/src/content/partials/vectorize/ @elithrar @mchenco @sejoker @cloudflare/pcx-technical-writing
25-
/src/content/changelogs/workers-ai.yaml @kathayl @G4brym @mchenco @daisyfaithauma @cloudflare/pcx-technical-writing
26-
/src/content/changelogs/ai-gateway.yaml @kathayl @G4brym @mchenco @daisyfaithauma @cloudflare/pcx-technical-writing
27-
/src/content/changelogs/vectorize.yaml @elithrar @mchenco @sejoker @cloudflare/pcx-technical-writing
25+
/src/content/release-notes/workers-ai.yaml @kathayl @G4brym @mchenco @daisyfaithauma @cloudflare/pcx-technical-writing
26+
/src/content/release-notes/ai-gateway.yaml @kathayl @G4brym @mchenco @daisyfaithauma @cloudflare/pcx-technical-writing
27+
/src/content/release-notes/vectorize.yaml @elithrar @mchenco @sejoker @cloudflare/pcx-technical-writing
2828

2929
# Analytics & Logs
3030

@@ -45,8 +45,8 @@
4545

4646
# Changelogs
4747

48-
/src/content/changelogs-next/ @cloudflare/pm-changelogs
49-
/src/assets/images/changelog-next/ @cloudflare/pm-changelogs
48+
/src/content/changelog/ @cloudflare/pm-changelogs
49+
/src/assets/images/changelog/ @cloudflare/pm-changelogs
5050

5151
# Cloudflare One
5252

@@ -62,8 +62,8 @@
6262
/src/content/docs/cloudflare-one/policies/data-loss-prevention/ @maxvp @cloudflare/pcx-technical-writing
6363
/src/content/docs/cloudflare-one/insights/dex/ @deadlypants1973 @cloudflare/pcx-technical-writing
6464
/src/content/docs/email-security/ @Maddy-Cloudflare @cloudflare/pcx-technical-writing
65-
/src/content/changelogs/access.yaml @ranbel @kennyj42 @cloudflare/pcx-technical-writing
66-
/src/content/changelogs/warp.yaml @kokolocomotion1 @ranbel @cloudflare/pcx-technical-writing
65+
/src/content/release-notes/access.yaml @ranbel @kennyj42 @cloudflare/pcx-technical-writing
66+
/src/content/release-notes/warp.yaml @kokolocomotion1 @ranbel @cloudflare/pcx-technical-writing
6767

6868
# Consumer products
6969

@@ -92,35 +92,35 @@
9292
/src/assets/images/calls/ @cloudflare/pcx-technical-writing @cloudflare/calls
9393
/public/calls/ @cloudflare/pcx-technical-writing @cloudflare/calls
9494
/src/content/docs/d1/ @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
95-
/src/content/changelogs/d1.yaml @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
95+
/src/content/release-notes/d1.yaml @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
9696
/src/content/partials/d1/ @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
9797
/src/content/docs/durable-objects/ @elithrar @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
98-
/src/content/changelogs/durable-objects.yaml @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
98+
/src/content/release-notes/durable-objects.yaml @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
9999
/src/content/docs/email-routing/ @cloudflare/pcx-technical-writing
100100
/src/content/docs/hyperdrive/ @elithrar @thomasgauvin @sejoker @oxyjun @cloudflare/pcx-technical-writing
101-
/src/content/changelogs/hyperdrive.yaml @elithrar @thomasgauvin @sejoker @oxyjun @cloudflare/pcx-technical-writing
101+
/src/content/release-notes/hyperdrive.yaml @elithrar @thomasgauvin @sejoker @oxyjun @cloudflare/pcx-technical-writing
102102
/src/content/partials/hyperdrive/ @elithrar @thomasgauvin @sejoker @oxyjun @cloudflare/pcx-technical-writing
103-
/src/content/changelogs/durable-objects.yaml @elithrar @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
103+
/src/content/release-notes/durable-objects.yaml @elithrar @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
104104
/src/content/docs/images/ @dcpena @cloudflare/pcx-technical-writing @renandincer @third774
105105
/src/content/docs/pages/ @cloudflare/workers-docs @GregBrimble @WalshyDev @aninibread @irvinebroque @cloudflare/pcx-technical-writing @ToriLindsay
106106
/src/assets/images/pages/ @cloudflare/workers-docs @GregBrimble @WalshyDev @aninibread @cloudflare/pcx-technical-writing @ToriLindsay
107-
/src/content/changelogs/pages.yaml @cloudflare/workers-docs @GregBrimble @WalshyDev @aninibread @cloudflare/pcx-technical-writing
107+
/src/content/release-notes/pages.yaml @cloudflare/workers-docs @GregBrimble @WalshyDev @aninibread @cloudflare/pcx-technical-writing
108108
/src/content/docs/kv/ @elithrar @thomasgauvin @rts-rob @oxyjun @cloudflare/pcx-technical-writing
109-
/src/content/changelogs/kv.yaml @elithrar @thomasgauvin @rts-rob @oxyjun @cloudflare/pcx-technical-writing
109+
/src/content/release-notes/kv.yaml @elithrar @thomasgauvin @rts-rob @oxyjun @cloudflare/pcx-technical-writing
110110
/src/content/partials/kv/ @elithrar @thomasgauvin @rts-rob @oxyjun @cloudflare/pcx-technical-writing
111111
/src/content/docs/pub-sub/ @elithrar @dcpena @cloudflare/pcx-technical-writing
112112
/src/content/docs/queues/ @elithrar @toddmantell @maheshwarip @cloudflare/pcx-technical-writing
113-
/src/content/changelogs/queues.yaml @elithrar @toddmantell @maheshwarip @cloudflare/pcx-technical-writing
113+
/src/content/release-notes/queues.yaml @elithrar @toddmantell @maheshwarip @cloudflare/pcx-technical-writing
114114
/src/content/docs/r2/ @oxyjun @elithrar @jonesphillip @cloudflare/workers-docs @cloudflare/pcx-technical-writing
115-
/src/content/changelogs/r2.yaml @oxyjun @elithrar @cloudflare/workers-docs @cloudflare/pcx-technical-writing
115+
/src/content/release-notes/r2.yaml @oxyjun @elithrar @cloudflare/workers-docs @cloudflare/pcx-technical-writing
116116
/src/content/docs/stream/ @tsmith512 @dcpena @cloudflare/pcx-technical-writing @renandincer @third774
117-
/src/content/changelogs/stream.yaml @tsmith512 @dcpena @cloudflare/pcx-technical-writing
117+
/src/content/release-notes/stream.yaml @tsmith512 @dcpena @cloudflare/pcx-technical-writing
118118
/src/content/docs/workers/ @cloudflare/workers-docs @GregBrimble @irvinebroque @mikenomitch @WalshyDev @cloudflare/deploy-config @cloudflare/pcx-technical-writing @ToriLindsay
119119
/src/content/partials/workers/ @cloudflare/workers-docs @GregBrimble @irvinebroque @mikenomitch @WalshyDev @cloudflare/deploy-config @cloudflare/pcx-technical-writing @ToriLindsay
120120
/src/assets/images/workers/ @cloudflare/workers-docs @GregBrimble @irvinebroque @WalshyDev @cloudflare/deploy-config @cloudflare/pcx-technical-writing @ToriLindsay
121-
/src/content/changelogs/workers.yaml @cloudflare/workers-docs @GregBrimble @WalshyDev @aninibread @cloudflare/deploy-config @cloudflare/pcx-technical-writing @irvinebroque @mikenomitch
121+
/src/content/release-notes/workers.yaml @cloudflare/workers-docs @GregBrimble @WalshyDev @aninibread @cloudflare/deploy-config @cloudflare/pcx-technical-writing @irvinebroque @mikenomitch
122122
/src/content/docs/zaraz/ @bjesus @jonnyparris @simonabadoiu @cloudflare/pcx-technical-writing
123-
/src/content/changelogs/zaraz.yaml @bjesus @jonnyparris @simonabadoiu @cloudflare/pcx-technical-writing
123+
/src/content/release-notes/zaraz.yaml @bjesus @jonnyparris @simonabadoiu @cloudflare/pcx-technical-writing
124124
/src/content/docs/workers/ci-cd/ @irvinebroque @aninibread @GregBrimble @ToriLindsay @cloudflare/pcx-technical-writing
125125
/src/content/docs/workers/runtime-apis/ @irvinebroque @jasnell @mikenomitch @GregBrimble @ToriLindsay @cloudflare/pcx-technical-writing
126126
/src/content/docs/workers/runtime-apis/bindings/ @irvinebroque @mikenomitch @GregBrimble @ToriLindsay @cloudflare/pcx-technical-writing
@@ -144,8 +144,8 @@
144144

145145
/src/content/docs/ddos-protection/ @patriciasantaana @cloudflare/pcx-technical-writing
146146
/src/content/docs/ddos-protection/change-log/ @antoinecordelle @patriciasantaana @cloudflare/pcx-technical-writing
147-
/src/content/changelogs/ddos-http.yaml @antoinecordelle @patriciasantaana @cloudflare/pcx-technical-writing
148-
/src/content/changelogs/ddos-network.yaml @antoinecordelle @patriciasantaana @cloudflare/pcx-technical-writing
147+
/src/content/release-notes/ddos-http.yaml @antoinecordelle @patriciasantaana @cloudflare/pcx-technical-writing
148+
/src/content/release-notes/ddos-network.yaml @antoinecordelle @patriciasantaana @cloudflare/pcx-technical-writing
149149

150150
# Docs team areas
151151

@@ -184,7 +184,7 @@
184184
# Radar
185185

186186
/src/content/docs/radar/ @meddulla @G4brym @tiagoad @andre-j3sus @cloudflare/pcx-technical-writing
187-
/src/content/changelogs/radar.yaml @meddulla @G4brym @tiagoad @andre-j3sus @cloudflare/pcx-technical-writing
187+
/src/content/release-notes/radar.yaml @meddulla @G4brym @tiagoad @andre-j3sus @cloudflare/pcx-technical-writing
188188

189189
# Reference architecture
190190

@@ -202,7 +202,7 @@
202202
/src/content/docs/ssl/ @RebeccaTamachiro @cloudflare/pcx-technical-writing
203203
/src/content/docs/waf/ @pedrosousa @cloudflare/firewall @cloudflare/pcx-technical-writing
204204
/src/content/docs/waf/change-log/ @pedrosousa @cloudflare/firewall @vs-mg @cloudflare/pcx-technical-writing
205-
/src/content/changelogs/waf.yaml @pedrosousa @cloudflare/firewall @vs-mg @cloudflare/pcx-technical-writing
205+
/src/content/release-notes/waf.yaml @pedrosousa @cloudflare/firewall @vs-mg @cloudflare/pcx-technical-writing
206206

207207
# Support
208208

@@ -216,7 +216,7 @@
216216
# Waiting Room
217217

218218
/src/content/docs/waiting-room/ @angelampcosta @cloudflare/pcx-technical-writing
219-
/src/content/changelogs/waiting-room.yaml @angelampcosta @cloudflare/pcx-technical-writing
219+
/src/content/release-notes/waiting-room.yaml @angelampcosta @cloudflare/pcx-technical-writing
220220

221221
# Web Analytics
222222

public/_redirects

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,14 @@
44
/dashboard-landing/ / 301
55
/tutorials/ /search/?content_type%5B0%5D=Tutorial 301
66
/sitemap.xml /sitemap-index.xml
7-
/changelog/index.xml /release-notes/index.xml 301
87
/deprecations/ /fundamentals/api/reference/deprecations/ 301
98

9+
# changelog
10+
/changelog/rss.xml /changelog/rss/index.xml 301
11+
12+
## legacy
13+
/changelog/index.xml /release-notes/index.xml 301
14+
1015
# 1dot1_redirect
1116
/1.1.1.1/1.1.1.1-for-families/ /1.1.1.1/setup/ 301
1217
/1.1.1.1/1.1.1.1-for-families/android/ /1.1.1.1/setup/android/ 301
File renamed without changes.

src/components/ProductChangelog.astro renamed to src/components/ProductReleaseNotes.astro

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,73 @@
11
---
22
import { getEntry, type CollectionEntry } from "astro:content";
33
import { marked } from "marked";
4-
import { getChangelogs } from "~/util/changelogs";
4+
import { getReleaseNotes } from "~/util/release-notes";
55
import AnchorHeading from "~/components/AnchorHeading.astro";
66
import { entryToString } from "~/util/container";
77
88
const page = await getEntry("docs", Astro.params.slug!);
99
1010
if (!page) {
1111
throw new Error(
12-
`[ProductChangelog] Failed to find entry for ${Astro.params.slug}.`,
12+
`[ProductReleaseNotes] Failed to find entry for ${Astro.params.slug}.`,
1313
);
1414
}
1515
16-
if (!page.data.changelog_file_name && !page.data.changelog_product_area_name) {
16+
if (
17+
!page.data.release_notes_file_name &&
18+
!page.data.release_notes_product_area_name
19+
) {
1720
throw new Error(
18-
`[ProductChangelog] ${Astro.params.slug} does not have a 'changelog_file_name' or 'changaelog_product_area_name' frontmatter property.`,
21+
`[ProductReleaseNotes] ${Astro.params.slug} does not have a 'release_notes_file_name' or 'changaelog_product_area_name' frontmatter property.`,
1922
);
2023
}
2124
22-
if (page.data.changelog_file_name && page.data.changelog_file_name.length > 1) {
25+
if (
26+
page.data.release_notes_file_name &&
27+
page.data.release_notes_file_name.length > 1
28+
) {
2329
throw new Error(
24-
`[ProductChangelog] This component cannot be used on files that have more than 1 entry in their 'changelog_file_name' frontmatter property.`,
30+
`[ProductReleaseNotes] This component cannot be used on files that have more than 1 entry in their 'release_notes_file_name' frontmatter property.`,
2531
);
2632
}
2733
2834
const name =
29-
page.data.changelog_product_area_name ?? page.data.changelog_file_name?.[0];
35+
page.data.release_notes_product_area_name ??
36+
page.data.release_notes_file_name?.[0];
3037
31-
let changelogs;
38+
let releaseNotes;
3239
33-
if (page.data.changelog_product_area_name) {
40+
if (page.data.release_notes_product_area_name) {
3441
const opts = {
35-
filter: (entry: CollectionEntry<"changelogs">) => {
42+
filter: (entry: CollectionEntry<"release-notes">) => {
3643
return entry.data.productArea === name;
3744
},
3845
};
39-
({ changelogs } = await getChangelogs(opts));
46+
({ releaseNotes } = await getReleaseNotes(opts));
4047
} else {
4148
if (name === "wrangler") {
4249
const opts = {
4350
wranglerOnly: true,
4451
};
45-
({ changelogs } = await getChangelogs(opts));
52+
({ releaseNotes } = await getReleaseNotes(opts));
4653
} else if (name === "api-deprecations") {
4754
const opts = {
4855
deprecationsOnly: true,
4956
};
50-
({ changelogs } = await getChangelogs(opts));
57+
({ releaseNotes } = await getReleaseNotes(opts));
5158
} else {
5259
const opts = {
53-
filter: (entry: CollectionEntry<"changelogs">) => {
60+
filter: (entry: CollectionEntry<"release-notes">) => {
5461
return entry.id === name;
5562
},
5663
};
57-
({ changelogs } = await getChangelogs(opts));
64+
({ releaseNotes } = await getReleaseNotes(opts));
5865
}
5966
}
6067
61-
if (!changelogs) {
68+
if (!releaseNotes) {
6269
throw new Error(
63-
`[ProductChangelog] Failed to find changelog called ${name}.`,
70+
`[ProductReleaseNotes] Failed to find release notes called ${name}.`,
6471
);
6572
}
6673
---
@@ -75,7 +82,7 @@ if (!changelogs) {
7582
)
7683
}
7784
{
78-
changelogs.map(([date, entries]) => (
85+
releaseNotes.map(([date, entries]) => (
7986
<div data-date={date}>
8087
{(entries ?? []).map(async (entry) => {
8188
let description;
@@ -102,7 +109,7 @@ if (!changelogs) {
102109
<AnchorHeading depth={2} title={page.data.title} />
103110
</a>
104111
<p class="text-xs">{entry.date}</p>
105-
{page.data.changelog_product_area_name && (
112+
{page.data.release_notes_product_area_name && (
106113
<h3 class="!mt-4">
107114
<a href={entry.productLink}>{entry.product}</a>
108115
</h3>
@@ -116,7 +123,7 @@ if (!changelogs) {
116123
<>
117124
<AnchorHeading depth={2} title={date} />
118125
<div data-product={entry.product.toLowerCase()}>
119-
{page.data.changelog_product_area_name && (
126+
{page.data.release_notes_product_area_name && (
120127
<h3 class="!mt-4">
121128
<a href={entry.productLink}>{entry.product}</a>
122129
</h3>

src/components/changelog-next/Header.astro renamed to src/components/changelog/Header.astro

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { z } from "astro:schema";
44
import { getEntry, type CollectionEntry } from "astro:content";
55
66
import { StarlightIcon } from "..";
7-
import HeroImage from "~/assets/images/changelog-next/hero.svg";
7+
import HeroImage from "~/assets/images/changelog/hero.svg";
88
99
type Props = z.input<typeof props>;
1010
@@ -14,9 +14,7 @@ const props = z.object({
1414
1515
const { notes } = props.parse(Astro.props);
1616
17-
async function uniqueProducts(
18-
notes: Array<CollectionEntry<"changelogs-next">>,
19-
) {
17+
async function uniqueProducts(notes: Array<CollectionEntry<"changelog">>) {
2018
const unique = [
2119
...new Set(notes.flatMap((e) => e.data.products.map((p) => p.id))),
2220
];
@@ -39,7 +37,7 @@ const products = await uniqueProducts(notes);
3937
<p>
4038
New updates and improvements at Cloudflare.
4139
<a
42-
href="/changelog/rss.xml"
40+
href="/changelog/rss/index.xml"
4341
class="dark:!hover:text-[#79B1FF] -mx-2 whitespace-nowrap px-2 text-[#056DFF] no-underline hover:rounded-[4px] hover:bg-[#DCEBFF] hover:!text-[#056DFF] dark:text-[#79B1FF] dark:hover:bg-[#002B66] max-sm:block"
4442
>
4543
Subscribe to RSS

0 commit comments

Comments
 (0)