You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,9 +35,11 @@ This spawns a server that will be accessible via `http://localhost:1111` in your
35
35
36
36
### Recommendations
37
37
38
-
Part of our application accesses the GitHub API (to populate the [Wrangler changelog](https://github.com/cloudflare/cloudflare-docs/blob/production/layouts/partials/wrangler-changelog.html)).
38
+
Part of our application accesses the GitHub API (to populate the [Wrangler changelog](https://developers.cloudflare.com/workers/platform/changelog/wrangler/)).
39
39
40
+
<!--
40
41
Since GitHub gives a higher request limit to authenticated requests, you may want to add a [classic token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic) with permissions for `repos:public_repo` to `/assets/secrets/github_token.txt`. The token value should be the only thing in your file.
42
+
-->
41
43
42
44
## Deployment
43
45
@@ -61,12 +63,12 @@ Please note that we may use AI tools to help us review technical documentation,
61
63
62
64
All commands are run from the root of the project, from a terminal:
Copy file name to clipboardExpand all lines: src/content/docs/ai-gateway/changelog.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,6 @@ sidebar:
9
9
10
10
import { ProductChangelog } from"~/components";
11
11
12
-
{/* <!-- Actual content lives in /data/changelogs/ai-gateway.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 --> */}
12
+
{/* <!-- Actual content lives in /src/content/changelogs/ai-gateway.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 --> */}
Copy file name to clipboardExpand all lines: src/content/docs/api-shield/changelog.mdx
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,10 @@ changelog_file_name:
5
5
- api-shield
6
6
sidebar:
7
7
order: 10
8
-
9
8
---
10
9
11
-
import { ProductChangelog } from"~/components"
10
+
import { ProductChangelog } from"~/components";
12
11
13
-
{/* <!-- Actual content lives in /content/changelogs/api-shield.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 --> */}
12
+
{/* <!-- Actual content lives in /src/content/changelogs/api-shield.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 --> */}
Copy file name to clipboardExpand all lines: src/content/docs/bots/changelog.mdx
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,10 @@ changelog_file_name:
5
5
- bots
6
6
sidebar:
7
7
order: 13
8
-
9
8
---
10
9
11
-
import { ProductChangelog } from"~/components"
10
+
import { ProductChangelog } from"~/components";
12
11
13
-
{/* <!-- Actual content lives in /content/changelogs/bots.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 --> */}
12
+
{/* <!-- Actual content lives in /src/content/changelogs/bots.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 --> */}
Copy file name to clipboardExpand all lines: src/content/docs/browser-rendering/changelog.mdx
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,11 +7,10 @@ sidebar:
7
7
order: 8
8
8
head: []
9
9
description: Review recent changes to Worker Browser Rendering.
10
-
11
10
---
12
11
13
-
import { ProductChangelog } from"~/components"
12
+
import { ProductChangelog } from"~/components";
14
13
15
-
{/* <!-- Actual content lives in /data/changelogs/radar.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 --> */}
14
+
{/* <!-- Actual content lives in /src/content/changelogs/radar.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 --> */}
Copy file name to clipboardExpand all lines: src/content/docs/d1/platform/changelog.mdx
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,10 @@ changelog_file_name:
5
5
- d1
6
6
sidebar:
7
7
order: 4
8
-
9
8
---
10
9
11
-
import { ProductChangelog } from"~/components"
10
+
import { ProductChangelog } from"~/components";
12
11
13
-
{/* <!-- Actual content lives in /data/changelogs/d1.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 --> */}
12
+
{/* <!-- Actual content lives in /src/content/changelogs/d1.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 --> */}
content: Changelog for general updates to DDoS protection
12
-
13
12
---
14
13
15
-
import { ProductChangelog } from"~/components"
14
+
import { ProductChangelog } from"~/components";
16
15
17
-
{/* <!-- Actual content lives in /content/changelogs/ddos.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 --> */}
16
+
{/* <!-- Actual content lives in /src/content/changelogs/ddos.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 --> */}
|[Internal link checking](https://github.com/cloudflare/cloudflare-docs/blob/production/bin/crawl.ts)| Evaluates all internal links to make sure they are in the current build. Increases cross linking while reducing maintenance cost. | GitHub Actions | Every commit |
21
-
| External link checking | Evaluates external links for broken links or links that redirect to another location. | SEO crawler | Weekly |
22
-
|[Header link checking](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/anchor-link-audit.yml)| Evaluates anchor links within our docs to make sure they resolve correctly. | GitHub Actions | Every weekend |
23
-
|[API docs link checking](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/api-links-crawl.yml)| Evaluates links to our API docs. | GitHub Actions | Every weekend |
24
-
|[Unused images check](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/image-audit.yml)| Flags images that are in our resources, but not currently referenced in our documentation. | GitHub Actions | Every month |
17
+
| Automation | Purpose | Implementation | Runs when |
| External link checking | Evaluates external links for broken links or links that redirect to another location. | SEO crawler | Weekly |
20
+
|[Header link checking](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/anchor-link-audit.yml)| Evaluates anchor links within our docs to make sure they resolve correctly. | GitHub Actions | Every weekend |
21
+
|[API docs link checking](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/api-links-crawl.yml)| Evaluates links to our API docs. | GitHub Actions | Every weekend |
22
+
|[Unused images check](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/image-audit.yml)| Flags images that are in our resources, but not currently referenced in our documentation. | GitHub Actions | Every month |
25
23
26
24
## Reporting
27
25
@@ -39,4 +37,3 @@ The following resources help contributors and stakeholders when they are making
39
37
|[Show before/after links](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/show-changed-files.yml)| Provides a comparison table that shows the current page in production and the changed page in a preview build. | GitHub Actions | Every Pages build |
40
38
|[Flag needed redirects](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/comment-changed-filenames.yml)| Comments with a list of changed or deleted files that might need a redirect. | GitHub Actions | Every commit |
41
39
|[Validate redirects](https://github.com/cloudflare/cloudflare-docs/blob/production/bin/validate-redirects.ts)| Verifies whether the commit adds conflicting or invalid redirects. | GitHub Actions | Every commit |
42
-
|[Spell check](https://github.com/cloudflare/cloudflare-docs/blob/production/.github/workflows/spell-check.yml)| Flags issues with spelling, casing, or insensitive language. | GitHub Actions | Every commit |
As much as you can, try to organize your redirects into logical groups (products, alphabetical order). This process helps prevent duplicate redirects, as well as identifying specific ones you might be looking for.
17
16
18
-
In our [Pages `_redirects` file](https://github.com/cloudflare/cloudflare-docs/blob/production/content/_redirects), we use extensive comments, separating different product areas. We also try, as much as we can, to keep the redirects in alphabetical order within a section.
17
+
In our [Pages `_redirects` file](https://github.com/cloudflare/cloudflare-docs/blob/production/public/_redirects), we use extensive comments, separating different product areas. We also try, as much as we can, to keep the redirects in alphabetical order within a section.
19
18
20
19
We used to apply a similar principle to [Bulk Redirect lists](/rules/url-forwarding/bulk-redirects/) (when that was our primary method). We created lists that grouped together similar products and labeled them as such, so it was easier to find which redirect you were looking for.
Copy file name to clipboardExpand all lines: src/content/docs/docs-guide/manage-content/redirects/process.mdx
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,6 @@ sidebar:
6
6
head:
7
7
- tag: title
8
8
content: Redirects | How we do it
9
-
10
9
---
11
10
12
11
There are [multiple ways](https://developers.google.com/search/docs/crawling-indexing/301-redirects) of performing redirects, including at your server, client-side redirects, and using a CDN.
@@ -19,7 +18,7 @@ We use various Cloudflare products for our redirects, due to ease of use and spe
19
18
20
19
### Cloudflare Pages (primary)
21
20
22
-
Our primary method takes advantage of the [Pages platform](/pages/configuration/redirects/), defining redirects in a [plain text file](https://github.com/cloudflare/cloudflare-docs/blob/production/content/_redirects) in our GitHub repo.
21
+
Our primary method takes advantage of the [Pages platform](/pages/configuration/redirects/), defining redirects in a [plain text file](https://github.com/cloudflare/cloudflare-docs/blob/production/public/_redirects) in our GitHub repo.
23
22
24
23
This setup allows us to use the same workflow for redirects as for any other documentation change. We implement a redirect in the same pull request as the content change and can test these changes in our preview branches.
25
24
@@ -33,7 +32,7 @@ Normally, bulk redirects only come up when another team is adding a large number
33
32
34
33
We use this method when the contributors are outside of our team and when the total number of redirects is so large that it would clutter our `_redirects` file and count against our [limit for Pages redirects](/pages/configuration/redirects/#surpass-_redirects-limits).
35
34
36
-
***
35
+
---
37
36
38
37
## When we add redirects
39
38
@@ -43,8 +42,8 @@ Our team adds redirects in two situations: during the course of normal content a
43
42
44
43
During normal content work, you want to add redirects when you do the following to a page:
45
44
46
-
* Change any part of the URL (filename, folder).
47
-
* Delete the page.
45
+
- Change any part of the URL (filename, folder).
46
+
- Delete the page.
48
47
49
48
We have some automation to help [flag needed redirects](/docs-guide/manage-content/automation/process/#contributor-resources).
0 commit comments