Skip to content

Commit 50e696f

Browse files
authored
Merge branch 'production' into pedro/2025-08-06-docs-update-mirage
2 parents 07422af + 6d4fdc7 commit 50e696f

File tree

3,019 files changed

+66962
-36819
lines changed

Some content is hidden

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

3,019 files changed

+66962
-36819
lines changed

.github/CODEOWNERS

Lines changed: 19 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@
66

77
/.github/ @kodster28 @pedrosousa @haleycode @kristianfreeman @GregBrimble @KianNH @maxvp @marciocloudflare @WalshyDev
88
/.github/CODEOWNERS @cloudflare/pcx-technical-writing
9-
/.github/actions/assign-issue/index.js @cloudflare/pcx-technical-writing
109
/.github/actions/assign-pr/index.js @cloudflare/pcx-technical-writing
11-
/.github/styles/cloudflare/spelling-exceptions.txt @cloudflare/pcx-technical-writing
1210
/src/components/ @cloudflare/developer-advocacy @kristianfreeman @kodster28 @pedrosousa @marciocloudflare @haleycode @maxvp @GregBrimble @KianNH @WalshyDev
1311
*.js @cloudflare/developer-advocacy @kristianfreeman @kodster28 @pedrosousa @haleycode @GregBrimble @KianNH @WalshyDev
1412
*.ts @cloudflare/developer-advocacy @kristianfreeman @kodster28 @pedrosousa @haleycode @GregBrimble @KianNH @WalshyDev
@@ -21,7 +19,7 @@
2119
# AI
2220

2321
/src/content/docs/agents/ @irvinebroque @rita3ko @elithrar @thomasgauvin @threepointone @cloudflare/pcx-technical-writing
24-
/src/content/docs/ai-gateway/ @kathayl @mchenco @kodster28 @cloudflare/pcx-technical-writing
22+
/src/content/docs/ai-gateway/ @abhishekkankani @palashgo @thebongy @kathayl @mchenco @kodster28 @cloudflare/pcx-technical-writing
2523
/src/content/docs/workers-ai/ @rita3ko @craigsdennis @markdembo @mchenco @kodster28 @cloudflare/pcx-technical-writing
2624
/src/content/docs/vectorize/ @elithrar @vy-ton @sejoker @mchenco @cloudflare/pcx-technical-writing
2725
/src/content/partials/vectorize/ @elithrar @mchenco @sejoker @cloudflare/pcx-technical-writing
@@ -60,16 +58,14 @@
6058
/src/content/docs/cloudflare-one/applications/ @kennyj42 @ranbel @cloudflare/pcx-technical-writing
6159
/src/content/docs/cloudflare-one/identity/ @kennyj42 @ranbel @cloudflare/pcx-technical-writing
6260
/src/content/docs/cloudflare-one/policies/access/ @kennyj42 @ranbel @cloudflare/pcx-technical-writing
63-
/src/content/docs/cloudflare-one/connections/connect-devices/ @kkrum @kokolocomotion1 @ranbel @cloudflare/pcx-technical-writing
64-
/src/content/docs/cloudflare-one/connections/connect-networks/ @ranbel @cloudflare/pcx-technical-writing
61+
/src/content/docs/cloudflare-one/connections/connect-devices/ @ranbel @cloudflare/pcx-technical-writing
62+
/src/content/docs/cloudflare-one/connections/connect-networks/ @nikitacano @ranbel @cloudflare/pcx-technical-writing
6563
/src/content/docs/cloudflare-one/applications/casb/ @maxvp @cloudflare/pcx-technical-writing
6664
/src/content/docs/cloudflare-one/policies/gateway/ @maxvp @cloudflare/pcx-technical-writing
6765
/src/content/docs/cloudflare-one/policies/browser-isolation/ @maxvp @ranbel @cloudflare/pcx-technical-writing
6866
/src/content/docs/cloudflare-one/policies/data-loss-prevention/ @maxvp @cloudflare/pcx-technical-writing
6967
/src/content/docs/cloudflare-one/insights/dex/ @deadlypants1973 @cloudflare/pcx-technical-writing
7068
/src/content/docs/email-security/ @Maddy-Cloudflare @cloudflare/pcx-technical-writing
71-
/src/content/release-notes/access.yaml @ranbel @kennyj42 @cloudflare/pcx-technical-writing
72-
/src/content/release-notes/warp.yaml @kokolocomotion1 @ranbel @cloudflare/pcx-technical-writing
7369

7470
# Consumer products
7571

@@ -95,12 +91,11 @@
9591

9692
# Developer Platform
9793

98-
/src/content/docs/containers/ @mikenomitch @th0m @cloudflare/pcx-technical-writing
99-
/src/content/release-notes/containers.yaml @mikenomitch @th0m @cloudflare/pcx-technical-writing
94+
/src/content/docs/containers/ @mikenomitch @th0m @cloudflare/pcx-technical-writing @cloudflare/cloudchamber
10095
/src/content/docs/d1/ @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @harshil1712 @cloudflare/pcx-technical-writing
10196
/src/content/release-notes/d1.yaml @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
10297
/src/content/partials/d1/ @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @harshil1712 @cloudflare/pcx-technical-writing
103-
/src/content/docs/ai-audit/ @oxyjun @kodster28 @cloudflare/pcx-technical-writing
98+
/src/content/docs/ai-crawl-control/ @oxyjun @kodster28 @cloudflare/pcx-technical-writing
10499
/src/content/docs/durable-objects/ @elithrar @vy-ton @joshthoward @oxyjun @harshil1712 @mikenomitch @cloudflare/pcx-technical-writing @cloudflare/workers-runtime-1
105100
/src/content/release-notes/durable-objects.yaml @elithrar @rozenmd @vy-ton @joshthoward @oxyjun @cloudflare/pcx-technical-writing
106101
/src/content/docs/email-routing/ @cloudflare/pcx-technical-writing
@@ -120,21 +115,20 @@
120115
/src/content/release-notes/queues.yaml @elithrar @jonesphillip @cloudflare/pcx-technical-writing
121116
/src/content/docs/r2/ @oxyjun @elithrar @jonesphillip @aninibread @harshil1712 @cloudflare/workers-docs @cloudflare/pcx-technical-writing
122117
/src/content/release-notes/r2.yaml @oxyjun @elithrar @aninibread @cloudflare/workers-docs @cloudflare/pcx-technical-writing
123-
/src/content/docs/realtime/ @cloudflare/pcx-technical-writing @cloudflare/calls
124-
/src/assets/images/realtime/ @cloudflare/pcx-technical-writing @cloudflare/calls
125-
/public/realtime/ @cloudflare/pcx-technical-writing @cloudflare/calls
118+
/src/content/docs/realtime/ @cloudflare/pcx-technical-writing @cloudflare/calls @roerohan @ravindra-dyte
119+
/src/assets/images/realtime/ @cloudflare/pcx-technical-writing @cloudflare/calls @roerohan @ravindra-dyte
120+
/public/realtime/ @cloudflare/pcx-technical-writing @cloudflare/calls @roerohan @ravindra-dyte
126121
/src/content/docs/stream/ @tsmith512 @ToriLindsay @cloudflare/pcx-technical-writing @renandincer @third774
127122
/src/content/release-notes/stream.yaml @tsmith512 @ToriLindsay @cloudflare/pcx-technical-writing
128123
/src/content/docs/workers/ @cloudflare/workers-docs @GregBrimble @irvinebroque @mikenomitch @korinne @WalshyDev @cloudflare/deploy-config @cloudflare/pcx-technical-writing @kodster28 @cloudflare/wrangler @cloudflare/workers-runtime-1 @cloudflare/wrangler
129124
/src/content/partials/workers/ @cloudflare/workers-docs @GregBrimble @irvinebroque @mikenomitch @WalshyDev @cloudflare/deploy-config @cloudflare/pcx-technical-writing @kodster28 @cloudflare/wrangler @cloudflare/workers-runtime-1 @cloudflare/wrangler
130125
/src/assets/images/workers/ @cloudflare/workers-docs @GregBrimble @irvinebroque @WalshyDev @cloudflare/deploy-config @cloudflare/pcx-technical-writing @kodster28 @cloudflare/wrangler @cloudflare/workers-runtime-1 @cloudflare/wrangler
131126
/src/content/release-notes/workers.yaml @cloudflare/workers-docs @GregBrimble @WalshyDev @aninibread @cloudflare/deploy-config @cloudflare/pcx-technical-writing @irvinebroque @mikenomitch
132-
/src/content/docs/zaraz/ @bjesus @jonnyparris @simonabadoiu @cloudflare/pcx-technical-writing
127+
/src/content/docs/zaraz/ @ToriLindsay @kathayl @bjesus @jonnyparris @simonabadoiu @cloudflare/pcx-technical-writing
133128
/src/content/release-notes/zaraz.yaml @bjesus @jonnyparris @simonabadoiu @cloudflare/pcx-technical-writing
134-
/src/content/docs/workers/ci-cd/ @irvinebroque @aninibread @GregBrimble @kodster28 @cloudflare/pcx-technical-writing
129+
/src/content/docs/workers/ci-cd/ @irvinebroque @aninibread @GregBrimble @kodster28 @cloudflare/pcx-technical-writing @yomna-shousha
135130
/src/content/compatibility-flags/ @irvinebroque @mikenomitch @GregBrimble @cloudflare/pcx-technical-writing
136131
/src/content/docs/workers/wrangler/ @cloudflare/wrangler @irvinebroque @kodster28 @cloudflare/pcx-technical-writing @cloudflare/workers-runtime-1
137-
/src/content/docs/workers/frameworks/ @igorminar @cloudflare/wrangler @aninibread @GregBrimble @kodster28 @cloudflare/pcx-technical-writing
138132
/src/content/docs/pages/framework-guides/ @igorminar @cloudflare/wrangler @aninibread @GregBrimble @kodster28 @cloudflare/pcx-technical-writing
139133
/src/content/docs/analytics/analytics-engine/ @irvinebroque @elithrar @cloudflare/pcx-technical-writing
140134
/src/content/docs/cloudflare-for-platforms/ @irvinebroque @dinasaur404 @cloudflare/pcx-technical-writing
@@ -155,7 +149,7 @@
155149
/src/content/docs/style-guide/ @dcpena @cloudflare/pcx-technical-writing
156150

157151
# Google tag gateway
158-
/src/content/docs/google-tag-gateway/ @simonabadoiu @jonnyparris @cloudflare/pcx-technical-writing
152+
/src/content/docs/google-tag-gateway/ @ToriLindsay @kathayl @simonabadoiu @jonnyparris @cloudflare/pcx-technical-writing
159153

160154
# Magic products
161155

@@ -168,7 +162,11 @@
168162
# Migration guides
169163

170164
/src/content/docs/migration-guides/ @kimj15 @cloudflare/pcx-technical-writing
171-
/src/assets/images/migration-guides/ @kimj15 @cloudflare/pcx-technical-writing
165+
166+
# MoQ
167+
168+
/src/content/docs/moq/ @englishm @renandincer @nils-ohlmeier @cloudflare/pcx-technical-writing
169+
/src/content/products/moq.yml @englishm @renandincer @nils-ohlmeier @cloudflare/pcx-technical-writing
172170

173171
# Performance products
174172

@@ -208,13 +206,13 @@
208206
/src/content/docs/ssl/ @RebeccaTamachiro @cloudflare/pcx-technical-writing
209207
/src/content/docs/waf/ @pedrosousa @cloudflare/firewall @cloudflare/pcx-technical-writing
210208
/src/content/docs/waf/change-log/ @pedrosousa @cloudflare/firewall @vs-mg @cloudflare/pcx-technical-writing
211-
/src/content/release-notes/waf.yaml @pedrosousa @cloudflare/firewall @vs-mg @cloudflare/pcx-technical-writing
212209
/src/content/docs/cloudflare-challenges/ @patriciasantaana @cloudflare/pcx-technical-writing
213210

214211
# Support
215212

216-
/src/content/docs/support/ @zeinjaber @TracyCloudflare @ngayerie @cloudflare/pcx-technical-writing @cloudflare/customer-support
217-
/src/assets/images/support/ @zeinjaber @TracyCloudflare @ngayerie @cloudflare/pcx-technical-writing @cloudflare/customer-support
213+
/src/content/docs/support/ @zeinjaber @ngayerie @cloudflare/pcx-technical-writing @cloudflare/customer-support
214+
/src/assets/images/support/ @zeinjaber @ngayerie @cloudflare/pcx-technical-writing @cloudflare/customer-support
215+
/src/content/docs/billing/ @zeinjaber @ngayerie @simon-says @cloudflare/customer-support @cloudflare/pcx-technical-writing
218216

219217
# Turnstile
220218

@@ -223,7 +221,6 @@
223221
# Waiting Room
224222

225223
/src/content/docs/waiting-room/ @angelampcosta @cloudflare/pcx-technical-writing
226-
/src/content/release-notes/waiting-room.yaml @angelampcosta @cloudflare/pcx-technical-writing
227224

228225
# Web Analytics
229226

.github/dependabot.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ updates:
88
schedule:
99
interval: "daily"
1010
assignees:
11-
- "KianNH"
11+
- "kodster28"
1212
reviewers:
13-
- "KianNH"
13+
- "kodster28"

.github/pull_request_template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
<!-- Remove items that do not apply -->
1212

13+
- [ ] Is there a [changelog](https://developers.cloudflare.com/changelog/) entry ([guidelines](https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/changelog/))? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to [RSS feeds](https://developers.cloudflare.com/fundamentals/new-features/available-rss-feeds/), the [Discord](https://discord.com/channels/595317990191398933/1040420029080018945), and [X](https://x.com/CFchangelog).
1314
- [ ] The [documentation style guide](https://developers.cloudflare.com/style-guide/) has been adhered to.
1415
- [ ] If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
1516
- [ ] Files which have changed name or location have been allocated [redirects](https://developers.cloudflare.com/pages/configuration/redirects/#per-file).

.github/workflows/ci.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,23 @@ jobs:
2727
node_modules/.astro/assets
2828
key: static
2929

30+
- run: |
31+
FILES=$(
32+
find src/content \
33+
-type f \
34+
-not -name '*.mdx' \
35+
-not -name '*.md' \
36+
-not -name '*.json' \
37+
-not -name '*.yml' \
38+
-not -name '*.yaml' \
39+
-not -name '*.txt'
40+
)
41+
42+
if [ -n "$FILES" ]; then
43+
echo "Found files with invalid file extensions:\n\n$FILES"
44+
exit 1
45+
fi
46+
3047
- run: npm ci
3148

3249
- run: npx tsx bin/post-codeowners-comment/index.ts

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,4 @@ pnpm-debug.log*
2929
/assets/secrets
3030
/worker/functions/
3131

32-
.idea
33-
34-
public/*
32+
.idea

CONTRIBUTING.md

Lines changed: 6 additions & 166 deletions
Original file line numberDiff line numberDiff line change
@@ -1,169 +1,9 @@
1-
# Contributing to Cloudflare's documentation
1+
# Contributing to Cloudflare's developer documentation
22

3-
Before contributing code to Cloudflare's documentation, please read the following guidelines carefully.
3+
Everyone, including those who are not part of the Cloudflare organization, are encouraged to contribute.
4+
- If you are not a Cloudflare employee, learn how to contribute in the [contribution page](https://developers.cloudflare.com/style-guide/contributions/) of the Cloudflare Style Guide.
5+
- If you are a Cloudflare employee, reach out via our Developer Docs space in Google chat.
46

5-
## Have feedback for our documentation? Open an issue
7+
Consult the [Cloudflare Style Guide](https://developers.cloudflare.com/style-guide/) on everything from grammar, to formatting, to frontmatter requirements. Browse our [components](/style-guide/components/) to add additional formatting such as [notes](/style-guide/documentation-content-strategy/component-attributes/notes-tips-warnings/) and [code blocks](/style-guide/components/code/).
68

7-
[Open an issue](https://github.com/cloudflare/cloudflare-docs/issues/new/choose) when something in our documentation is incorrect, out-of-date, or if the documentation doesn’t match the actual functionality.
8-
9-
## Before submitting a PR, open an issue
10-
11-
Before proposing significant changes, such as adding a new page, [open an issue](https://github.com/cloudflare/cloudflare-docs/issues/new/choose) so that we can discuss your approach first. Only members of the Cloudflare organization can open a pull request on the repository, and they should follow the same guidance on opening an issue for significant changes. If you’re not part of the Cloudflare organization but want to contribute, fork the repository and then create a pull request.
12-
13-
A member of the Product Content Experience team will review the pull request. If the changes are straightforward, the pull request is approved and can be merged. If the pull request is more technical and requires an additional review, the new reviewer will leave any additional feedback.
14-
15-
If a pull request is not approved, the “won't fix” label is applied and a comment is added to explain why the pull request was closed.
16-
17-
If we require more information to address your pull request, the `more-information-needed` label will be applied to the pull request. If more information has not been provided within fourteen days, the pull request will automatically close.
18-
19-
### Pull Request Guidelines
20-
21-
- Commits and commit messages
22-
- Use smaller commits for your work to make it easier to review. In your commit messages, be specific about what you changed in the files.
23-
- If you are proposing a new page, review our [content type guidelines](https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/) for options and templates.
24-
- Pull request titles
25-
- Follow the title structure of [Product Name] + work you did + affected file(s)
26-
- Example: [Access] fix broken link in example_file.md
27-
- Pull request descriptions
28-
- Use bullet points to summarize the changes in the commits
29-
- Add any other information you think is helpful or needs to be addressed. If your PR fixes an open issue, indicate that your PR is addressing the issue and provide a link to the issue.
30-
31-
## Package manager
32-
33-
- [npm](https://nodejs.org/en/learn/getting-started/an-introduction-to-the-npm-package-manager#introduction-to-npm) is the recommended package manager that must be used in installing dependencies.
34-
- The generated `package-lock.json` file must be committed to git.
35-
36-
## Wrangler config
37-
38-
If you are adding a code snippet to the docs that represents a Wrangler config file (`wrangler.toml`, `wrangler.json`, or `wrangler.jsonc`) make sure you wrap it with the `<WranglerConfig>` component, which ensures it is rendered as both JSON and TOML. For example:
39-
40-
````
41-
42-
import { WranglerConfig } from "~/components";
43-
44-
<WranglerConfig>
45-
46-
```toml
47-
# Top-level configuration
48-
name = "my-worker"
49-
main = "src/index.js"
50-
compatibility_date = "2022-07-12"
51-
52-
workers_dev = false
53-
route = { pattern = "example.org/*", zone_name = "example.org" }
54-
55-
kv_namespaces = [
56-
{ binding = "<MY_NAMESPACE>", id = "<KV_ID>" }
57-
]
58-
59-
[env.staging]
60-
name = "my-worker-staging"
61-
route = { pattern = "staging.example.org/*", zone_name = "example.org" }
62-
63-
kv_namespaces = [
64-
{ binding = "<MY_NAMESPACE>", id = "<STAGING_KV_ID>" }
65-
]
66-
```
67-
68-
</WranglerConfig>
69-
70-
````
71-
72-
## Workers Playground
73-
74-
If you are adding a code snippet to the docs that is:
75-
76-
1. A fully contained, valid Worker (i.e. it does not require external dependencies or specific bindings)
77-
2. Only JavaScript
78-
79-
you can add `playground: true` to the code block metadata to render a button to let users open the Worker in the [Playground](https://workers.new). For example:
80-
81-
````
82-
```js
83-
---
84-
playground: true
85-
---
86-
export default {
87-
async fetch(request) {
88-
/**
89-
* Replace `remote` with the host you wish to send requests to
90-
*/
91-
const remote = "https://example.com";
92-
93-
return await fetch(remote, request);
94-
},
95-
};
96-
```
97-
````
98-
99-
would render as
100-
101-
<img width="870" alt="Screenshot 2024-02-20 at 14 29 22" src="https://github.com/cloudflare/cloudflare-docs/assets/28503158/56aa8016-b3b6-4d64-8213-b1a26f16534a">
102-
103-
## GraphQL API Explorer
104-
105-
If you are adding a code snippet to the documentation that is an executable GraphQL query, you can add `graphql-api-explorer` right after `graphql` in the code block metadata (both must be present). This will render a button that allows users to open the query in the [GraphQL API Explorer](https://graphql.cloudflare.com/explorer). For example:
106-
107-
````
108-
```graphql graphql-api-explorer title="A GraphQL query"
109-
query GraphqlExample($zoneTag: string, $start: Time, $end: Time) {
110-
viewer {
111-
zones(filter: { zoneTag: $zoneTag }) {
112-
firewallEventsAdaptive(
113-
filter: { datetime_gt: $start, datetime_lt: $end }
114-
limit: 2
115-
orderBy: [datetime_DESC]
116-
) {
117-
action
118-
datetime
119-
host: clientRequestHTTPHost
120-
}
121-
}
122-
}
123-
}
124-
```
125-
````
126-
127-
When a user selects the `Run in GraphQL API Explorer` button, the following variables will be pre-populated in the GraphQL API Explorer along with the query.
128-
129-
:::note
130-
The user must be logged in or have an API token saved to see the query and variables pre-populated.
131-
:::
132-
133-
```
134-
{"zoneTag":"ZONE_ID", "start":"2025-05-07T14:54:36Z", "end":"2025-05-07T20:54:36Z"}
135-
```
136-
137-
### Conventions to auto populate `Variables` section in the GraphQL API Explorer
138-
139-
By default, the `Variables` section will be automatically populated based on the variables used in the GraphQL query.
140-
141-
- Any variable name that includes `start` and has a type of `Time` --> start: "2025-05-09T14:58:06Z" (6 hours from the current time)
142-
- e.g. `datetimeStart` also has `start` keyword, so it will be recognized for a start time (or date)
143-
- Any variable name that includes `end` and has a type of `Time` --> end: "2025-05-09T20:58:06Z" (current time)
144-
- Any variable name that includes `start` and has a type of `Date` --> start: "2025-05-07" (24 hours from the current date)
145-
- Any variable name that includes `end` and has a type of `Date` --> end: "2025-05-08" (current date)
146-
- `zoneTag` and has a type of `string` --> zoneTag: "ZONE_ID"
147-
- `accountTag` and has a type of `string` --> accountTag: "ACCOUNT_ID"
148-
- Any variable name that includes `id` and has a type of `string` --> id: "REPLACE_WITH_ID"
149-
- Any variable name and has a type of string --> anyString: "REPLACE_WITH_STRING"
150-
- `limit` with type `*int*` --> limit: 100
151-
152-
In addition to the variables that are automatically populated, you can add custom variables by setting their values as a JSON string in the `graphql-api-explorer` metadata.
153-
154-
````
155-
```graphql graphql-api-explorer='{"uID": "something"}' title="A GraphQL query"
156-
query GraphqlExample($zoneTag: string, $start: Time, $end: Time) {
157-
viewer {
158-
zones(filter: { zoneTag: $zoneTag }) {
159-
...
160-
}
161-
}
162-
}
163-
````
164-
165-
The variables added via the metadata value will be merged with the automatically populated variables.
166-
167-
```
168-
{"zoneTag":"ZONE_ID", "start":"2025-05-07T14:54:36Z", "end":"2025-05-07T20:54:36Z", "uId": "something"}
169-
```
9+
Thank you for helping us to maintain quality documentation.

0 commit comments

Comments
 (0)