Skip to content

Commit dab00fe

Browse files
authored
[Docs] Update URLs (Hugo, old folder structure) (cloudflare#17322)
1 parent 11833cc commit dab00fe

File tree

54 files changed

+199
-248
lines changed

Some content is hidden

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

54 files changed

+199
-248
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,11 @@ This spawns a server that will be accessible via `http://localhost:1111` in your
3535

3636
### Recommendations
3737

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/)).
3939

40+
<!--
4041
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+
-->
4143

4244
## Deployment
4345

@@ -61,12 +63,12 @@ Please note that we may use AI tools to help us review technical documentation,
6163

6264
All commands are run from the root of the project, from a terminal:
6365

64-
| Command | Action |
65-
| :------------------------ | :----------------------------------------------- |
66-
| `npm install` | Installs dependencies |
67-
| `npm run dev` | Starts local dev server at `localhost:4321` |
68-
| `npx astro build` | Build your production site to `./dist/` |
69-
| `npm run astro -- --help` | Get help using the Astro CLI |
66+
| Command | Action |
67+
|:--------------------------|:--------------------------------------------|
68+
| `npm install` | Installs dependencies |
69+
| `npm run dev` | Starts local dev server at `localhost:1111` |
70+
| `npx astro build` | Build your production site to `./dist/` |
71+
| `npm run astro -- --help` | Get help using the Astro CLI |
7072

7173
## 👀 Want to learn more?
7274

src/content/docs/ai-gateway/changelog.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ sidebar:
99

1010
import { ProductChangelog } from "~/components";
1111

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 --> */}
1313

1414
<ProductChangelog />

src/content/docs/api-shield/changelog.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@ changelog_file_name:
55
- api-shield
66
sidebar:
77
order: 10
8-
98
---
109

11-
import { ProductChangelog } from "~/components"
10+
import { ProductChangelog } from "~/components";
1211

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 --> */}
1413

1514
<ProductChangelog />

src/content/docs/bots/changelog.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@ changelog_file_name:
55
- bots
66
sidebar:
77
order: 13
8-
98
---
109

11-
import { ProductChangelog } from "~/components"
10+
import { ProductChangelog } from "~/components";
1211

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 --> */}
1413

1514
<ProductChangelog />

src/content/docs/browser-rendering/changelog.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@ sidebar:
77
order: 8
88
head: []
99
description: Review recent changes to Worker Browser Rendering.
10-
1110
---
1211

13-
import { ProductChangelog } from "~/components"
12+
import { ProductChangelog } from "~/components";
1413

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 --> */}
1615

1716
<ProductChangelog />

src/content/docs/d1/platform/changelog.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@ changelog_file_name:
55
- d1
66
sidebar:
77
order: 4
8-
98
---
109

11-
import { ProductChangelog } from "~/components"
10+
import { ProductChangelog } from "~/components";
1211

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 --> */}
1413

1514
<ProductChangelog />
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'General updates'
2+
title: "General updates"
33
pcx_content_type: concept
44
changelog_file_name:
55
- ddos
@@ -9,11 +9,10 @@ sidebar:
99
head:
1010
- tag: title
1111
content: Changelog for general updates to DDoS protection
12-
1312
---
1413

15-
import { ProductChangelog } from "~/components"
14+
import { ProductChangelog } from "~/components";
1615

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 --> */}
1817

1918
<ProductChangelog />

src/content/docs/docs-guide/manage-content/automation/process.mdx

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ sidebar:
66
head:
77
- tag: title
88
content: Automation | How we do it
9-
109
---
1110

1211
Cloudflare uses the following automations to streamline our documentation process.
@@ -15,13 +14,12 @@ Cloudflare uses the following automations to streamline our documentation proces
1514

1615
At Cloudflare, we use several automations to reduce the cost associated with content maintenance.
1716

18-
| Automation | Purpose | Implementation | Runs when |
19-
| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------- |
20-
| [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 |
18+
| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------------- | ------------- |
19+
| 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 |
2523

2624
## Reporting
2725

@@ -39,4 +37,3 @@ The following resources help contributors and stakeholders when they are making
3937
| [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 |
4038
| [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 |
4139
| [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 |

src/content/docs/docs-guide/manage-content/redirects/best-practices.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ sidebar:
66
head:
77
- tag: title
88
content: Redirects | Best practices
9-
109
---
1110

1211
Beyond [how Cloudflare uses redirects](/docs-guide/manage-content/redirects/process/), we follow these best practices.
@@ -15,7 +14,7 @@ Beyond [how Cloudflare uses redirects](/docs-guide/manage-content/redirects/proc
1514

1615
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.
1716

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.
1918

2019
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.
2120

src/content/docs/docs-guide/manage-content/redirects/process.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ sidebar:
66
head:
77
- tag: title
88
content: Redirects | How we do it
9-
109
---
1110

1211
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
1918

2019
### Cloudflare Pages (primary)
2120

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.
2322

2423
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.
2524

@@ -33,7 +32,7 @@ Normally, bulk redirects only come up when another team is adding a large number
3332

3433
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).
3534

36-
***
35+
---
3736

3837
## When we add redirects
3938

@@ -43,8 +42,8 @@ Our team adds redirects in two situations: during the course of normal content a
4342

4443
During normal content work, you want to add redirects when you do the following to a page:
4544

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.
4847

4948
We have some automation to help [flag needed redirects](/docs-guide/manage-content/automation/process/#contributor-resources).
5049

0 commit comments

Comments
 (0)