Skip to content

Commit c624dd5

Browse files
committed
small pages fixes
1 parent 08bf00b commit c624dd5

File tree

10 files changed

+40
-26
lines changed

10 files changed

+40
-26
lines changed

src/content/docs/pages/configuration/git-integration/github-integration.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ Every time you open a new pull request on your GitHub repository, Cloudflare Pag
2323

2424
![GitHub Preview Urls](~/assets/images/pages/configuration/ghpreviewurls.png)
2525

26+
:::note
27+
Commits/PRs created from forked repositories will not create a preview.
28+
:::
29+
2630
### Skipping a build via a commit message
2731

2832
Without any configuration required, you can choose to skip a deployment on an adhoc basis. By adding the `[CI Skip]`, `[CI-Skip]`, `[Skip CI]`, `[Skip-CI]`, or `[CF-Pages-Skip]` flag as a prefix in your commit message, and Pages will omit that deployment. The prefixes are not case sensitive.
@@ -53,7 +57,7 @@ When authorizing Cloudflare Pages to access a GitHub account, you can specify ac
5357

5458
:::caution[GitHub security consideration]
5559

56-
A GitHub account should only point to one Cloudflare account, however, this is not enforced. If you are setting up Cloudflare with GitHub for your organization, Cloudflare recommends that you limit the scope of the application to only the repositories you intend to build with Pages at the time that you set up your project. You can modify these permissions as you build more applications.
60+
A GitHub account should only point to one Cloudflare account. If you are setting up Cloudflare with GitHub for your organization, Cloudflare recommends that you limit the scope of the application to only the repositories you intend to build with Pages. You can modify these permissions by going to the [Applications page](https://github.com/settings/installations) on GitHub, select **Switch settings context** to access your GitHub organization settings. Then, select **Cloudflare Workers & Pages** > For **Repository access**, select **Only select repositories** > select your repositories.
5761

5862
:::
5963

src/content/docs/pages/configuration/git-integration/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Cloudflare supports connecting Cloudflare Pages to your [GitHub](/pages/configur
77

88
Using Git integration with Cloudflare also provides:
99

10-
- **Preview deployments for custom branches**, generating preview URLs for any branch in the repository without affecting your production deployment.
10+
- **Preview deployments for custom branches**, generating preview URLs for a commit to any branch in the repository without affecting your production deployment.
1111
- **Preview URLs in pull requests** (PRs) to the repository.
1212
- **Build and deployment status checks** within the Git repository.
1313
- **Skipping builds using a commit message**.
@@ -32,8 +32,8 @@ Cloudflare Pages supports the following Git providers:
3232

3333
If you use [GitHub Enterprise Server](https://docs.github.com/en/[email protected]/admin/overview/about-github-enterprise-server), [Self-Managed GitLab](https://about.gitlab.com/pricing/), or another Git provider (e.g., Bitbucket), you can:
3434

35-
- Start with a Direct Upload project and deploy using a CI/CD provider with [Wrangler CLI](/workers/wrangler/commands/#deploy)
36-
- Or, [disable automatic deployments](/pages/configuration/git-integration/#disable-automatic-deployments) in a Git-integrated project and use a CI/CD provider to deploy with [Wrangler CLI](/workers/wrangler/commands/#deploy).
35+
- Start with a Direct Upload project and deploy using a [CI/CD provider with Wrangler CLI](/pages/how-to/use-direct-upload-with-continuous-integration/).
36+
- Or, [disable automatic deployments](/pages/configuration/git-integration/#disable-automatic-deployments) in a Git-integrated project and use a [CI/CD provider with Wrangler CLI](/pages/how-to/use-direct-upload-with-continuous-integration/).
3737

3838
## Adding Git Integration
3939

src/content/docs/pages/get-started/c3.mdx

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,14 @@ description: Use C3 (`create-cloudflare` CLI) to set up and deploy new
1010
deployment.
1111
---
1212

13-
import { Render, TabItem, Tabs, Type, MetaInfo, PackageManagers } from "~/components";
13+
import {
14+
Render,
15+
TabItem,
16+
Tabs,
17+
Type,
18+
MetaInfo,
19+
PackageManagers,
20+
} from "~/components";
1421

1522
Cloudflare provides a CLI command for creating new Workers and Pages projects — `npm create cloudflare`, powered by the [`create-cloudflare` package](https://www.npmjs.com/package/create-cloudflare).
1623

@@ -229,7 +236,7 @@ Cloudflare collects anonymous usage data to improve `create-cloudflare` over tim
229236
You can opt-out if you do not wish to share any information.
230237

231238
<PackageManagers
232-
type="create"
239+
type="create"
233240
pkg="cloudflare@latest"
234241
args="telemetry disable"
235242
/>
@@ -243,15 +250,15 @@ export CREATE_CLOUDFLARE_TELEMETRY_DISABLED=1
243250
You can check the status of telemetry collection at any time.
244251

245252
<PackageManagers
246-
type="create"
247-
pkg="cloudflare@latest"
248-
args="telemetry status"
253+
type="create"
254+
pkg="cloudflare@latest"
255+
args="telemetry status"
249256
/>
250257

251258
You can always re-enable telemetry collection.
252259

253260
<PackageManagers
254-
type="create"
255-
pkg="cloudflare@latest"
256-
args="telemetry enable"
261+
type="create"
262+
pkg="cloudflare@latest"
263+
args="telemetry enable"
257264
/>

src/content/docs/pages/get-started/direct-upload.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ description: Upload your prebuilt assets to Pages and deploy them via the
1010

1111
import { Render } from "~/components";
1212

13-
Direct Upload enables you to upload your prebuilt assets to Pages and deploy them to the Cloudflare global network. This guide will instruct you how to upload your assets using Wrangler or the drag and drop method.
13+
Direct Upload enables you to upload your prebuilt assets to Pages and deploy them to the Cloudflare global network. You should choose Direct Upload over Git integration if you want to [integrate your own build platform](/pages/how-to/use-direct-upload-with-continuous-integration/) or upload from your local computer.
1414

15-
:::caution
15+
This guide will instruct you how to upload your assets using Wrangler or the drag and drop method.
16+
17+
:::caution[You cannot switch to Git integration later]
1618
If you choose Direct Upload, you cannot switch to [Git integration](/pages/get-started/git-integration/) later. You will have to create a new project with Git integration to use automatic deployments.
1719
:::
1820

src/content/docs/pages/get-started/git-integration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: Connect your Git provider to Pages.
99

1010
import { Details, Render } from "~/components";
1111

12-
In this guide, you will get started with Cloudflare Pages, and deploy your first website to the Pages platform through Git integration. The Git integration enables automatic builds and deployments every time you push a change to your connected GitHub or GitLab repository.
12+
In this guide, you will get started with Cloudflare Pages, and deploy your first website to the Pages platform through Git integration. The Git integration enables automatic builds and deployments every time you push a change to your connected [GitHub](/pages/configuration/git-integration/github-integration/) or [GitLab](/pages/configuration/git-integration/gitlab-integration/) repository.
1313

1414
:::caution[You cannot switch to Direct Upload later]
1515
If you deploy using the Git integration, you cannot switch to [Direct Upload](/pages/get-started/direct-upload/) later. However, if you already use a Git-integrated project and do not want to trigger deployments every time you push a commit, you can [disable automatic deployments](/pages/configuration/git-integration/#disable-automatic-deployments) on all branches. Then, you can use Wrangler to deploy directly to your Pages projects and make changes to your Git repository without automatically triggering a build.

src/content/docs/pages/platform/known-issues.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Here are some known bugs and issues with Cloudflare Pages:
1919

2020
## Git configuration
2121

22-
- After you have selected a GitHub/GitLab repository for your Pages application, it cannot be changed. Delete your Pages project and create a new one pointing at a different repository if you need to update it.
22+
- If you deploy using the Git integration, you cannot switch to Direct Upload later. However, if you already use a Git-integrated project and do not want to trigger deployments every time you push a commit, you can [disable/pause automatic deployments](/pages/configuration/git-integration/#disable-automatic-deployments). Alternatively, you can delete your Pages project and create a new one pointing at a different repository if you need to update it.
2323

2424
## Build configuration
2525

src/content/docs/workers/ci-cd/builds/git-integration/github-integration.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To add Cloudflare Workers installation to an organization, your user account mus
4444

4545
:::caution[GitHub security consideration]
4646

47-
A GitHub account should only point to one Cloudflare account. If you are setting up Cloudflare with GitHub for your organization, Cloudflare recommends that you limit the scope of the application to only the repositories you intend to build with Workers at the time that you set up your project. You can modify these permissions as you build more applications.
47+
A GitHub account should only point to one Cloudflare account. If you are setting up Cloudflare with GitHub for your organization, Cloudflare recommends that you limit the scope of the application to only the repositories you intend to build with Pages. You can modify these permissions by going to the [Applications page](https://github.com/settings/installations) on GitHub, select **Switch settings context** to access your GitHub organization settings. Then, select **Cloudflare Workers & Pages** > For **Repository access**, select **Only select repositories** > select your repositories.
4848

4949
:::
5050

src/content/docs/workers/ci-cd/builds/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ If a build succeeds, it is uploaded as a version. If the build is configured to
4343

4444
:::
4545

46-
## Disabling Builds
46+
## Disconnecting Builds
4747

4848
To disable automatic builds and deployments from your Git repository, go to **Settings** > **Builds** and select **Disconnect** under **Git Repositories**. If you want to switch to a different repository for your Worker, you must first disable Builds, then reconnect to select the new repository.
4949

src/content/docs/workers/get-started/dashboard.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@ sidebar:
66
head:
77
- tag: title
88
content: Get started - Dashboard
9-
109
---
1110

12-
import { Render } from "~/components"
11+
import { Render } from "~/components";
1312

1413
Follow this guide to create a Workers application using [the Cloudflare dashboard](https://dash.cloudflare.com).
1514

@@ -38,6 +37,7 @@ To create a Workers application:
3837

3938
To do more:
4039

40+
- Push your project to a GitHub or GitLab respoitory then [connect to Builds](/workers/ci-cd/builds/#get-started) to enable automatic builds and deployments.
4141
- Review our [Examples](/workers/examples/) and [Tutorials](/workers/tutorials/) for inspiration.
4242
- Set up [bindings](/workers/runtime-apis/bindings/) to allow your Worker to interact with other resources and unlock new functionality.
4343
- Learn how to [test and debug](/workers/testing/) your Workers.

src/content/docs/workers/get-started/guide.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@ cd my-first-worker
4848

4949
In your project directory, C3 will have generated the following:
5050

51-
* `wrangler.toml`: Your [Wrangler](/workers/wrangler/configuration/#sample-wranglertoml-configuration) configuration file.
52-
* `index.js` (in `/src`): A minimal `'Hello World!'` Worker written in [ES module](/workers/reference/migrate-to-module-workers/) syntax.
53-
* `package.json`: A minimal Node dependencies configuration file.
54-
* `package-lock.json`: Refer to [`npm` documentation on `package-lock.json`](https://docs.npmjs.com/cli/v9/configuring-npm/package-lock-json).
55-
* `node_modules`: Refer to [`npm` documentation `node_modules`](https://docs.npmjs.com/cli/v7/configuring-npm/folders#node-modules).
51+
- `wrangler.toml`: Your [Wrangler](/workers/wrangler/configuration/#sample-wranglertoml-configuration) configuration file.
52+
- `index.js` (in `/src`): A minimal `'Hello World!'` Worker written in [ES module](/workers/reference/migrate-to-module-workers/) syntax.
53+
- `package.json`: A minimal Node dependencies configuration file.
54+
- `package-lock.json`: Refer to [`npm` documentation on `package-lock.json`](https://docs.npmjs.com/cli/v9/configuring-npm/package-lock-json).
55+
- `node_modules`: Refer to [`npm` documentation `node_modules`](https://docs.npmjs.com/cli/v7/configuring-npm/folders#node-modules).
5656

5757
</Details>
5858

@@ -191,14 +191,15 @@ Preview your Worker at `<YOUR_WORKER>.<YOUR_SUBDOMAIN>.workers.dev`.
191191

192192
<Details header="Seeing 523 errors?">
193193

194-
If you see [`523` errors](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-523-origin-is-unreachable) when pushing your `*.workers.dev` subdomain for the first time, wait a minute or so and the errors will resolve themselves.
194+
If you see [`523` errors](/support/troubleshooting/cloudflare-errors/troubleshooting-cloudflare-5xx-errors/#error-523-origin-is-unreachable) when pushing your `*.workers.dev` subdomain for the first time, wait a minute or so and the errors will resolve themselves.
195195

196196
</Details>
197197

198198
## Next steps
199199

200200
To do more:
201201

202+
- Push your project to a GitHub or GitLab respoitory then [connect to Builds](/workers/ci-cd/builds/#get-started) to enable automatic builds and deployments.
202203
- Visit the [Cloudflare dashboard](https://dash.cloudflare.com/) for simpler editing.
203204
- Review our [Examples](/workers/examples/) and [Tutorials](/workers/tutorials/) for inspiration.
204205
- Set up [bindings](/workers/runtime-apis/bindings/) to allow your Worker to interact with other resources and unlock new functionality.

0 commit comments

Comments
 (0)