diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index c1ad54883629a7b..05b3070a052e88e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -127,7 +127,7 @@ /src/content/docs/workers/reference/migrate-to-module-workers/ @irvinebroque @GregBrimble @ToriLindsay @cloudflare/deploy-config @cloudflare/pcx-technical-writing /src/content/docs/workers/reference/security-model/ @irvinebroque @GregBrimble @ToriLindsay @cloudflare/pcx-technical-writing -/src/content/compatibility-dates/ @irvinebroque @mikenomitch @GregBrimble @cloudflare/pcx-technical-writing +/src/content/compatibility-flags/ @irvinebroque @mikenomitch @GregBrimble @cloudflare/pcx-technical-writing /src/content/docs/workers/wrangler/ @penalosa @petebacondarwin @dario-piotrowicz @irvinebroque @GregBrimble @ToriLindsay @cloudflare/pcx-technical-writing /src/content/docs/workers/frameworks/ @igorminar @dario-piotrowicz @jculvey @aninibread @GregBrimble @ToriLindsay @cloudflare/pcx-technical-writing /src/content/docs/pages/framework-guides/ @igorminar @dario-piotrowicz @jculvey @aninibread @GregBrimble @tanushree-sharma @ToriLindsay @cloudflare/pcx-technical-writing diff --git a/public/_redirects b/public/_redirects index 3d7a0660232195d..d91af0af55a08bb 100644 --- a/public/_redirects +++ b/public/_redirects @@ -1449,6 +1449,7 @@ /workers/platform/triggers/cron-triggers/ /workers/configuration/cron-triggers/ 301 /workers/platform/cron-triggers/ /workers/configuration/cron-triggers/ 301 /workers/platform/compatibility-dates/ /workers/configuration/compatibility-dates/ 301 +/workers/platform/compatibility-dates.json /workers/platform/compatibility-flags.json 301 /workers/learning/integrations/ /workers/configuration/integrations/ 301 /workers/learning/integrations/apis/ /workers/configuration/integrations/apis/ 301 /workers/learning/integrations/external-services/ /workers/configuration/integrations/external-services/ 301 diff --git a/src/components/CompatibilityDates.astro b/src/components/CompatibilityFlags.astro similarity index 95% rename from src/components/CompatibilityDates.astro rename to src/components/CompatibilityFlags.astro index e2989d84e68e696..0cb70507dfdb532 100644 --- a/src/components/CompatibilityDates.astro +++ b/src/components/CompatibilityFlags.astro @@ -11,7 +11,7 @@ const props = z.object({ const { experimental } = props.parse(Astro.props); -let flags = await getCollection("compatibility-dates"); +let flags = await getCollection("compatibility-flags"); if (experimental) { flags = flags.filter((x) => x.data.experimental); diff --git a/src/components/index.ts b/src/components/index.ts index 251ac2ddd35b7dd..7c28f185b6960d5 100644 --- a/src/components/index.ts +++ b/src/components/index.ts @@ -7,7 +7,7 @@ export { Icon as AstroIcon } from "astro-icon/components"; // Custom components export { default as AnchorHeading } from "./AnchorHeading.astro"; export { default as AvailableNotifications } from "./AvailableNotifications.astro"; -export { default as CompatibilityDates } from "./CompatibilityDates.astro"; +export { default as CompatibilityFlags } from "./CompatibilityFlags.astro"; export { default as Description } from "./Description.astro"; export { default as Details } from "./Details.astro"; export { default as DirectoryListing } from "./DirectoryListing.astro"; diff --git a/src/content/compatibility-dates/allow-custom-ports.md b/src/content/compatibility-flags/allow-custom-ports.md similarity index 100% rename from src/content/compatibility-dates/allow-custom-ports.md rename to src/content/compatibility-flags/allow-custom-ports.md diff --git a/src/content/compatibility-dates/blob-standard-mime-type.md b/src/content/compatibility-flags/blob-standard-mime-type.md similarity index 100% rename from src/content/compatibility-dates/blob-standard-mime-type.md rename to src/content/compatibility-flags/blob-standard-mime-type.md diff --git a/src/content/compatibility-dates/brotli-content-encoding.md b/src/content/compatibility-flags/brotli-content-encoding.md similarity index 100% rename from src/content/compatibility-dates/brotli-content-encoding.md rename to src/content/compatibility-flags/brotli-content-encoding.md diff --git a/src/content/compatibility-dates/cache-no-store.md b/src/content/compatibility-flags/cache-no-store.md similarity index 100% rename from src/content/compatibility-dates/cache-no-store.md rename to src/content/compatibility-flags/cache-no-store.md diff --git a/src/content/compatibility-dates/commonjs-modules-dont-export-a-module-namespace.md b/src/content/compatibility-flags/commonjs-modules-dont-export-a-module-namespace.md similarity index 100% rename from src/content/compatibility-dates/commonjs-modules-dont-export-a-module-namespace.md rename to src/content/compatibility-flags/commonjs-modules-dont-export-a-module-namespace.md diff --git a/src/content/compatibility-dates/crypto-preserve-public-exponent.md b/src/content/compatibility-flags/crypto-preserve-public-exponent.md similarity index 100% rename from src/content/compatibility-dates/crypto-preserve-public-exponent.md rename to src/content/compatibility-flags/crypto-preserve-public-exponent.md diff --git a/src/content/compatibility-dates/dont-substitute-null-on-type-error.md b/src/content/compatibility-flags/dont-substitute-null-on-type-error.md similarity index 100% rename from src/content/compatibility-dates/dont-substitute-null-on-type-error.md rename to src/content/compatibility-flags/dont-substitute-null-on-type-error.md diff --git a/src/content/compatibility-dates/dont-throw-from-async-functions.md b/src/content/compatibility-flags/dont-throw-from-async-functions.md similarity index 100% rename from src/content/compatibility-dates/dont-throw-from-async-functions.md rename to src/content/compatibility-flags/dont-throw-from-async-functions.md diff --git a/src/content/compatibility-dates/dont-use-the-custom-origin-trust-store-for-external-subrequests.md b/src/content/compatibility-flags/dont-use-the-custom-origin-trust-store-for-external-subrequests.md similarity index 100% rename from src/content/compatibility-dates/dont-use-the-custom-origin-trust-store-for-external-subrequests.md rename to src/content/compatibility-flags/dont-use-the-custom-origin-trust-store-for-external-subrequests.md diff --git a/src/content/compatibility-dates/durable-object-stub-fetch-requires-a-full-url.md b/src/content/compatibility-flags/durable-object-stub-fetch-requires-a-full-url.md similarity index 100% rename from src/content/compatibility-dates/durable-object-stub-fetch-requires-a-full-url.md rename to src/content/compatibility-flags/durable-object-stub-fetch-requires-a-full-url.md diff --git a/src/content/compatibility-dates/dynamic-dispatch-tunnel-exceptions.md b/src/content/compatibility-flags/dynamic-dispatch-tunnel-exceptions.md similarity index 100% rename from src/content/compatibility-dates/dynamic-dispatch-tunnel-exceptions.md rename to src/content/compatibility-flags/dynamic-dispatch-tunnel-exceptions.md diff --git a/src/content/compatibility-dates/fetch-improperly-interprets-unknown-protocols-as-http.md b/src/content/compatibility-flags/fetch-improperly-interprets-unknown-protocols-as-http.md similarity index 100% rename from src/content/compatibility-dates/fetch-improperly-interprets-unknown-protocols-as-http.md rename to src/content/compatibility-flags/fetch-improperly-interprets-unknown-protocols-as-http.md diff --git a/src/content/compatibility-dates/fetch-standard-url.md b/src/content/compatibility-flags/fetch-standard-url.md similarity index 100% rename from src/content/compatibility-dates/fetch-standard-url.md rename to src/content/compatibility-flags/fetch-standard-url.md diff --git a/src/content/compatibility-dates/fetcher-no-get-put-delete.md b/src/content/compatibility-flags/fetcher-no-get-put-delete.md similarity index 100% rename from src/content/compatibility-dates/fetcher-no-get-put-delete.md rename to src/content/compatibility-flags/fetcher-no-get-put-delete.md diff --git a/src/content/compatibility-dates/formdata-parsing-supports-file.md b/src/content/compatibility-flags/formdata-parsing-supports-file.md similarity index 100% rename from src/content/compatibility-dates/formdata-parsing-supports-file.md rename to src/content/compatibility-flags/formdata-parsing-supports-file.md diff --git a/src/content/compatibility-dates/global-navigator.md b/src/content/compatibility-flags/global-navigator.md similarity index 100% rename from src/content/compatibility-dates/global-navigator.md rename to src/content/compatibility-flags/global-navigator.md diff --git a/src/content/compatibility-dates/htmlrewriter-handling-of-esi-include.md b/src/content/compatibility-flags/htmlrewriter-handling-of-esi-include.md similarity index 100% rename from src/content/compatibility-dates/htmlrewriter-handling-of-esi-include.md rename to src/content/compatibility-flags/htmlrewriter-handling-of-esi-include.md diff --git a/src/content/compatibility-dates/http_headers_getsetcookie.md b/src/content/compatibility-flags/http_headers_getsetcookie.md similarity index 100% rename from src/content/compatibility-dates/http_headers_getsetcookie.md rename to src/content/compatibility-flags/http_headers_getsetcookie.md diff --git a/src/content/compatibility-dates/internal_stream_byob_return_view.md b/src/content/compatibility-flags/internal_stream_byob_return_view.md similarity index 100% rename from src/content/compatibility-dates/internal_stream_byob_return_view.md rename to src/content/compatibility-flags/internal_stream_byob_return_view.md diff --git a/src/content/compatibility-dates/minimal-subrequests.md b/src/content/compatibility-flags/minimal-subrequests.md similarity index 100% rename from src/content/compatibility-dates/minimal-subrequests.md rename to src/content/compatibility-flags/minimal-subrequests.md diff --git a/src/content/compatibility-dates/new-url-parser-implementation.md b/src/content/compatibility-flags/new-url-parser-implementation.md similarity index 100% rename from src/content/compatibility-dates/new-url-parser-implementation.md rename to src/content/compatibility-flags/new-url-parser-implementation.md diff --git a/src/content/compatibility-dates/no-cfbotmanagement-default.md b/src/content/compatibility-flags/no-cfbotmanagement-default.md similarity index 100% rename from src/content/compatibility-dates/no-cfbotmanagement-default.md rename to src/content/compatibility-flags/no-cfbotmanagement-default.md diff --git a/src/content/compatibility-dates/no-importscripts.md b/src/content/compatibility-flags/no-importscripts.md similarity index 100% rename from src/content/compatibility-dates/no-importscripts.md rename to src/content/compatibility-flags/no-importscripts.md diff --git a/src/content/compatibility-dates/nodejs-als.md b/src/content/compatibility-flags/nodejs-als.md similarity index 100% rename from src/content/compatibility-dates/nodejs-als.md rename to src/content/compatibility-flags/nodejs-als.md diff --git a/src/content/compatibility-dates/nodejs-compat.md b/src/content/compatibility-flags/nodejs-compat.md similarity index 100% rename from src/content/compatibility-dates/nodejs-compat.md rename to src/content/compatibility-flags/nodejs-compat.md diff --git a/src/content/compatibility-dates/python-workers.md b/src/content/compatibility-flags/python-workers.md similarity index 100% rename from src/content/compatibility-dates/python-workers.md rename to src/content/compatibility-flags/python-workers.md diff --git a/src/content/compatibility-dates/queues-json-messages.md b/src/content/compatibility-flags/queues-json-messages.md similarity index 100% rename from src/content/compatibility-dates/queues-json-messages.md rename to src/content/compatibility-flags/queues-json-messages.md diff --git a/src/content/compatibility-dates/r2-list-honor-includes.md b/src/content/compatibility-flags/r2-list-honor-includes.md similarity index 100% rename from src/content/compatibility-dates/r2-list-honor-includes.md rename to src/content/compatibility-flags/r2-list-honor-includes.md diff --git a/src/content/compatibility-dates/rpc.md b/src/content/compatibility-flags/rpc.md similarity index 100% rename from src/content/compatibility-dates/rpc.md rename to src/content/compatibility-flags/rpc.md diff --git a/src/content/compatibility-dates/setters-getters-on-api-object-prototypes.md b/src/content/compatibility-flags/setters-getters-on-api-object-prototypes.md similarity index 100% rename from src/content/compatibility-dates/setters-getters-on-api-object-prototypes.md rename to src/content/compatibility-flags/setters-getters-on-api-object-prototypes.md diff --git a/src/content/compatibility-dates/spec-compliant-response-redirect.md b/src/content/compatibility-flags/spec-compliant-response-redirect.md similarity index 100% rename from src/content/compatibility-dates/spec-compliant-response-redirect.md rename to src/content/compatibility-flags/spec-compliant-response-redirect.md diff --git a/src/content/compatibility-dates/streams-byob-reader-detaches-buffer.md b/src/content/compatibility-flags/streams-byob-reader-detaches-buffer.md similarity index 100% rename from src/content/compatibility-dates/streams-byob-reader-detaches-buffer.md rename to src/content/compatibility-flags/streams-byob-reader-detaches-buffer.md diff --git a/src/content/compatibility-dates/streams-constructors.md b/src/content/compatibility-flags/streams-constructors.md similarity index 100% rename from src/content/compatibility-dates/streams-constructors.md rename to src/content/compatibility-flags/streams-constructors.md diff --git a/src/content/compatibility-dates/strict-compression.md b/src/content/compatibility-flags/strict-compression.md similarity index 100% rename from src/content/compatibility-dates/strict-compression.md rename to src/content/compatibility-flags/strict-compression.md diff --git a/src/content/compatibility-dates/strict-crypto.md b/src/content/compatibility-flags/strict-crypto.md similarity index 100% rename from src/content/compatibility-dates/strict-crypto.md rename to src/content/compatibility-flags/strict-crypto.md diff --git a/src/content/compatibility-dates/transformstream-standard-constructor.md b/src/content/compatibility-flags/transformstream-standard-constructor.md similarity index 100% rename from src/content/compatibility-dates/transformstream-standard-constructor.md rename to src/content/compatibility-flags/transformstream-standard-constructor.md diff --git a/src/content/compatibility-dates/unwrap-custom-thenables.md b/src/content/compatibility-flags/unwrap-custom-thenables.md similarity index 100% rename from src/content/compatibility-dates/unwrap-custom-thenables.md rename to src/content/compatibility-flags/unwrap-custom-thenables.md diff --git a/src/content/compatibility-dates/urlsearchparams-deletehasvalue.md b/src/content/compatibility-flags/urlsearchparams-deletehasvalue.md similarity index 100% rename from src/content/compatibility-dates/urlsearchparams-deletehasvalue.md rename to src/content/compatibility-flags/urlsearchparams-deletehasvalue.md diff --git a/src/content/compatibility-dates/vectorize-query-metadata-optional.md b/src/content/compatibility-flags/vectorize-query-metadata-optional.md similarity index 100% rename from src/content/compatibility-dates/vectorize-query-metadata-optional.md rename to src/content/compatibility-flags/vectorize-query-metadata-optional.md diff --git a/src/content/compatibility-dates/web-socket-compression.md b/src/content/compatibility-flags/web-socket-compression.md similarity index 100% rename from src/content/compatibility-dates/web-socket-compression.md rename to src/content/compatibility-flags/web-socket-compression.md diff --git a/src/content/config.ts b/src/content/config.ts index 3a0c07abccc3f2f..60cccf2337838d5 100644 --- a/src/content/config.ts +++ b/src/content/config.ts @@ -7,7 +7,7 @@ import { notificationsSchema, pagesBuildEnvironmentSchema, pagesFrameworkPresetsSchema, - compatibilityDatesSchema, + compatibilityFlagsSchema, glossarySchema, learningPathsSchema, videosSchema, @@ -29,8 +29,8 @@ export const collections = { schema: changelogsSchema, type: "data", }), - "compatibility-dates": defineCollection({ - schema: compatibilityDatesSchema, + "compatibility-flags": defineCollection({ + schema: compatibilityFlagsSchema, }), partials: defineCollection({ schema: partialSchema, diff --git a/src/content/docs/workers/configuration/compatibility-dates.mdx b/src/content/docs/workers/configuration/compatibility-dates.mdx index 8b8acd9d40eb069..2b851b91f36adf2 100644 --- a/src/content/docs/workers/configuration/compatibility-dates.mdx +++ b/src/content/docs/workers/configuration/compatibility-dates.mdx @@ -1,7 +1,7 @@ --- pcx_content_type: concept title: Compatibility dates -rss: https://github.com/cloudflare/cloudflare-docs/commits/production/src/content/compatibility-dates.atom +rss: https://github.com/cloudflare/cloudflare-docs/commits/production/src/content/compatibility-flags.atom head: [] description: Opt into a specific version of the Workers runtime for your Workers project. --- diff --git a/src/content/docs/workers/configuration/compatibility-flags.mdx b/src/content/docs/workers/configuration/compatibility-flags.mdx index e689ef2c3eee4bc..f630259b299cc7b 100644 --- a/src/content/docs/workers/configuration/compatibility-flags.mdx +++ b/src/content/docs/workers/configuration/compatibility-flags.mdx @@ -6,7 +6,7 @@ head: [] description: Opt into a specific features of the Workers runtime for your Workers project. --- -import { CompatibilityDates } from "~/components"; +import { CompatibilityFlags } from "~/components"; Compatibility flags enable specific features. They can be useful if you want to help the Workers team test upcoming changes that are not yet enabled by default, or if you need to hold back a change that your code depends on but still want to apply other compatibility changes. @@ -61,14 +61,14 @@ The Node.js `AsyncLocalStorage` API is a particularly useful feature for Workers compatibility_flags = [ "nodejs_als" ] ``` -## Change history +## Flags history -Newest changes are listed first. +Newest flags are listed first. - + -## Experimental changes +## Experimental flags -These changes can be enabled via `compatibility_flags`, but are not yet scheduled to become default on any particular date. +These flags can be enabled via `compatibility_flags`, but are not yet scheduled to become default on any particular date. - + diff --git a/src/content/videos/index.yaml b/src/content/videos/index.yaml index 7d79c5ad46d1a9a..e393efa95454457 100644 --- a/src/content/videos/index.yaml +++ b/src/content/videos/index.yaml @@ -286,7 +286,7 @@ entries: content_type: 🎥 Video pcx_content_type: tutorial - link: https://developers.cloudflare.com/workers/frameworks/framework-guides/nextjs/#video-tutorial - title: Deploy NextJS to your Workers Application + title: Deploy NextJS to your Workers Application description: Watch to learn how to easily deploy your NextJS application to the Cloudflare global network. tags: [NextJS, Workers, Pages] languages: [TypeScript] @@ -310,10 +310,10 @@ entries: updated: 2024-10-31 difficulty: Intermediate content_type: 🎥 Video - pcx_content_type: tutorial + pcx_content_type: tutorial - link: https://youtu.be/RmF05GpLE20 title: DevTalk Episode 02 | Post-Quantum Cryptography - description: Bas Westerbaan is Cloudflare’s Research Lead on Post-Quantum efforts. His work ranges from cryptographic implementation and standardization, to driving large-scale experiment and subsequent deployment. + description: Bas Westerbaan is Cloudflare’s Research Lead on Post-Quantum efforts. His work ranges from cryptographic implementation and standardization, to driving large-scale experiment and subsequent deployment. tags: [SSL] languages: [TypeScript] products: [SSL] @@ -322,7 +322,7 @@ entries: updated: 2024-11-14 difficulty: Beginner content_type: 🎥 Video - pcx_content_type: tutorial + pcx_content_type: tutorial - link: https://youtu.be/xu4Wb-IppmM title: OpenAI Relay Server on Cloudflare Workers description: In this video, Craig Dennis walks you through the deployment of OpenAI's relay server to use with their realtime API. @@ -334,7 +334,7 @@ entries: updated: 2024-11-14 difficulty: Intermediate content_type: 🎥 Video - pcx_content_type: tutorial + pcx_content_type: tutorial - link: https://developers.cloudflare.com/workers/runtime-apis/rpc/#video-tutorial title: Workers RPC Tutorial description: Learn how to implement RPC in your JavaScript applications and build serverless solutions. @@ -346,10 +346,10 @@ entries: updated: 2024-11-10 difficulty: Beginner content_type: 🎥 Video - pcx_content_type: tutorial + pcx_content_type: tutorial - link: https://youtu.be/B2bLUc3iOsI title: Deploy your React App to Cloudflare Workers - description: Learn how to deploy an existing React application to Cloudflare Workers. + description: Learn how to deploy an existing React application to Cloudflare Workers. tags: [Workers, Pages] languages: [TypeScript] products: [Workers, Pages] @@ -358,10 +358,10 @@ entries: updated: 2024-11-05 difficulty: Intermediate content_type: 🎥 Video - pcx_content_type: tutorial - # - link: - # title: - # description: + pcx_content_type: tutorial + # - link: + # title: + # description: # tags: [Workers, Pages] # languages: [TypeScript] # products: [Workers, Pages] @@ -370,4 +370,4 @@ entries: # updated: 2024-11-14 # difficulty: Intermediate # content_type: 🎥 Video - # pcx_content_type: tutorial + # pcx_content_type: tutorial diff --git a/src/pages/workers/platform/compatibility-dates.json.ts b/src/pages/workers/platform/compatibility-flags.json.ts similarity index 90% rename from src/pages/workers/platform/compatibility-dates.json.ts rename to src/pages/workers/platform/compatibility-flags.json.ts index 56748e73eb474e7..089fa1c7d99a540 100644 --- a/src/pages/workers/platform/compatibility-dates.json.ts +++ b/src/pages/workers/platform/compatibility-flags.json.ts @@ -1,7 +1,7 @@ import { getCollection } from "astro:content"; export async function GET() { - const entries = await getCollection("compatibility-dates"); + const entries = await getCollection("compatibility-flags"); entries.sort((a, b) => a.data.sort_date.localeCompare(b.data.sort_date)); diff --git a/src/schemas/compatibility-dates.ts b/src/schemas/compatibility-flags.ts similarity index 65% rename from src/schemas/compatibility-dates.ts rename to src/schemas/compatibility-flags.ts index b4dfac16f7895fb..f35f8b572a14973 100644 --- a/src/schemas/compatibility-dates.ts +++ b/src/schemas/compatibility-flags.ts @@ -1,8 +1,8 @@ import { z } from "astro:schema"; -export type CompatibilityDatesSchema = z.infer; +export type CompatibilityFlagsSchema = z.infer; -export const compatibilityDatesSchema = z.object({ +export const compatibilityFlagsSchema = z.object({ name: z.string(), enable_date: z.string().optional().nullable(), enable_flag: z.string().nullable(), diff --git a/src/schemas/index.ts b/src/schemas/index.ts index 6f7408ee1431341..3288e0e47cda269 100644 --- a/src/schemas/index.ts +++ b/src/schemas/index.ts @@ -1,7 +1,7 @@ export * from "./apps"; export * from "./base"; export * from "./changelogs"; -export * from "./compatibility-dates"; +export * from "./compatibility-flags"; export * from "./glossary"; export * from "./learning-paths"; export * from "./notifications";