From 35db52fece71105b8a97870fcf502d91b1e49a15 Mon Sep 17 00:00:00 2001 From: Greg Brimble Date: Mon, 23 Sep 2024 11:58:51 -0400 Subject: [PATCH] Update deploy command docs --- .../frameworks/framework-guides/angular.mdx | 4 +- .../frameworks/framework-guides/astro.mdx | 4 +- .../framework-guides/docusaurus.mdx | 4 +- .../frameworks/framework-guides/gatsby.mdx | 4 +- .../frameworks/framework-guides/nuxt.mdx | 6 +- .../frameworks/framework-guides/qwik.mdx | 71 +++++++++++++++++++ .../frameworks/framework-guides/remix.mdx | 4 +- .../frameworks/framework-guides/solid.mdx | 71 +++++++++++++++++++ .../frameworks/framework-guides/svelte.mdx | 71 +++++++++++++++++++ 9 files changed, 233 insertions(+), 6 deletions(-) create mode 100644 src/content/docs/workers/frameworks/framework-guides/qwik.mdx create mode 100644 src/content/docs/workers/frameworks/framework-guides/solid.mdx create mode 100644 src/content/docs/workers/frameworks/framework-guides/svelte.mdx diff --git a/src/content/docs/workers/frameworks/framework-guides/angular.mdx b/src/content/docs/workers/frameworks/framework-guides/angular.mdx index 88f7f361b628de..bfb422fe96303e 100644 --- a/src/content/docs/workers/frameworks/framework-guides/angular.mdx +++ b/src/content/docs/workers/frameworks/framework-guides/angular.mdx @@ -52,7 +52,9 @@ After you have created your project, run the following command in the project di ## 3. Deploy your Project -Deploy your Worker via Wrangler to a `*.workers.dev` subdomain or configure a [Custom Domain](/workers/configuration/routing/custom-domains/). +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. diff --git a/src/content/docs/workers/frameworks/framework-guides/astro.mdx b/src/content/docs/workers/frameworks/framework-guides/astro.mdx index 1be4e9dd99c1c7..2799cb2bfea3e4 100644 --- a/src/content/docs/workers/frameworks/framework-guides/astro.mdx +++ b/src/content/docs/workers/frameworks/framework-guides/astro.mdx @@ -52,7 +52,9 @@ After you have created your project, run the following command in the project di ## 3. Deploy your Project -Deploy your Worker via Wrangler to a `*.workers.dev` subdomain or configure a [Custom Domain](/workers/configuration/routing/custom-domains/). +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. diff --git a/src/content/docs/workers/frameworks/framework-guides/docusaurus.mdx b/src/content/docs/workers/frameworks/framework-guides/docusaurus.mdx index 0c9a9fab317789..a51089cea89799 100644 --- a/src/content/docs/workers/frameworks/framework-guides/docusaurus.mdx +++ b/src/content/docs/workers/frameworks/framework-guides/docusaurus.mdx @@ -52,7 +52,9 @@ After you have created your project, run the following command in the project di ## 3. Deploy your Project -Deploy your Worker via Wrangler to a `*.workers.dev` subdomain or configure a [Custom Domain](/workers/configuration/routing/custom-domains/). +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. diff --git a/src/content/docs/workers/frameworks/framework-guides/gatsby.mdx b/src/content/docs/workers/frameworks/framework-guides/gatsby.mdx index 7e0c072acc8820..ec6994eeda8004 100644 --- a/src/content/docs/workers/frameworks/framework-guides/gatsby.mdx +++ b/src/content/docs/workers/frameworks/framework-guides/gatsby.mdx @@ -52,7 +52,9 @@ After you have created your project, run the following command in the project di ## 3. Deploy your Project -Deploy your Worker via Wrangler to a `*.workers.dev` subdomain or configure a [Custom Domain](/workers/configuration/routing/custom-domains/). +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. diff --git a/src/content/docs/workers/frameworks/framework-guides/nuxt.mdx b/src/content/docs/workers/frameworks/framework-guides/nuxt.mdx index d54b4c64280c4c..c517831343b7f0 100644 --- a/src/content/docs/workers/frameworks/framework-guides/nuxt.mdx +++ b/src/content/docs/workers/frameworks/framework-guides/nuxt.mdx @@ -52,7 +52,9 @@ After you have created your project, run the following command in the project di ## 3. Deploy your Project -Deploy your Worker via Wrangler to a `*.workers.dev` subdomain or configure a [Custom Domain](/workers/configuration/routing/custom-domains/). +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. @@ -65,3 +67,5 @@ Your Nuxt application can be fully integrated with the Cloudflare Developer Plat ## Static assets You can serve static assets your Nuxt application by placing them in [the `./public/` directory](https://nuxt.com/docs/guide/directory-structure/public). This can be useful for resource files such as images, stylesheets, fonts, and manifests. + + diff --git a/src/content/docs/workers/frameworks/framework-guides/qwik.mdx b/src/content/docs/workers/frameworks/framework-guides/qwik.mdx new file mode 100644 index 00000000000000..4311df84e92752 --- /dev/null +++ b/src/content/docs/workers/frameworks/framework-guides/qwik.mdx @@ -0,0 +1,71 @@ +--- +pcx_content_type: how-to +title: Qwik +sidebar: + badge: Beta +head: [] +description: Create a Qwik application and deploy it to Cloudflare Workers with Workers Assets. +--- + +import { + Badge, + Description, + InlineBadge, + Render, + PackageManagers, +} from "~/components"; + +In this guide, you will create a new [Qwik](https://qwik.dev/) application and deploy to Cloudflare Workers (with the new [ Workers Assets](/workers/configuration/assets/)). + +## 1. Set up a new project + +Use the [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) CLI (C3) to set up a new project. C3 will create a new project directory, initiate Qwik's official setup tool, and provide the option to deploy instantly. + +To use `create-cloudflare` to create a new Qwik project with Workers Assets, run the following command: + + + + + +After setting up your project, change your directory by running the following command: + +```sh +cd my-qwik-app +``` + +## 2. Develop locally + +After you have created your project, run the following command in the project directory to start a local server. This will allow you to preview your project locally during development. + + + +## 3. Deploy your Project + +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. + + + +--- + +## Bindings + +Your Qwik application can be fully integrated with the Cloudflare Developer Platform, in both local development and in production, by using product bindings. The [Qwik documentation](https://qwik.dev/docs/deployments/cloudflare-pages/#context) provides information about configuring bindings and how you can access them in your Qwik endpoint methods. + +## Static assets + +You can serve static assets your Qwik application by placing them in [the `./public/` directory](https://qwik.dev/docs/advanced/static-assets/). This can be useful for resource files such as images, stylesheets, fonts, and manifests. + + diff --git a/src/content/docs/workers/frameworks/framework-guides/remix.mdx b/src/content/docs/workers/frameworks/framework-guides/remix.mdx index b69a75283f280d..992ba75f117743 100644 --- a/src/content/docs/workers/frameworks/framework-guides/remix.mdx +++ b/src/content/docs/workers/frameworks/framework-guides/remix.mdx @@ -52,7 +52,9 @@ After you have created your project, run the following command in the project di ## 3. Deploy your Project -Deploy your Worker via Wrangler to a `*.workers.dev` subdomain or configure a [Custom Domain](/workers/configuration/routing/custom-domains/). +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. diff --git a/src/content/docs/workers/frameworks/framework-guides/solid.mdx b/src/content/docs/workers/frameworks/framework-guides/solid.mdx new file mode 100644 index 00000000000000..9e8a7cd0f45639 --- /dev/null +++ b/src/content/docs/workers/frameworks/framework-guides/solid.mdx @@ -0,0 +1,71 @@ +--- +pcx_content_type: how-to +title: Solid +sidebar: + badge: Beta +head: [] +description: Create a Solid application and deploy it to Cloudflare Workers with Workers Assets. +--- + +import { + Badge, + Description, + InlineBadge, + Render, + PackageManagers, +} from "~/components"; + +In this guide, you will create a new [Solid](https://www.solidjs.com/) application and deploy to Cloudflare Workers (with the new [ Workers Assets](/workers/configuration/assets/)). + +## 1. Set up a new project + +Use the [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) CLI (C3) to set up a new project. C3 will create a new project directory, initiate Solid's official setup tool, and provide the option to deploy instantly. + +To use `create-cloudflare` to create a new Solid project with Workers Assets, run the following command: + + + + + +After setting up your project, change your directory by running the following command: + +```sh +cd my-solid-app +``` + +## 2. Develop locally + +After you have created your project, run the following command in the project directory to start a local server. This will allow you to preview your project locally during development. + + + +## 3. Deploy your Project + +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. + + + +--- + +## Bindings + +Your Solid application can be fully integrated with the Cloudflare Developer Platform, in both local development and in production, by using product bindings. The [Solid documentation](https://docs.solidjs.com/reference/server-utilities/get-request-event) provides information about how to access platform primitives, including bindings. Specifically, for Cloudflare, you can use [`getRequestEnv().nativeEvent.context.cloudflare.env`](https://docs.solidjs.com/solid-start/advanced/request-events#nativeevent) to access bindings. + +## Static assets + +You can serve static assets your Solid application by placing them in [the `./public/` directory](https://docs.solidjs.com/solid-start/building-your-application/static-assets). This can be useful for resource files such as images, stylesheets, fonts, and manifests. + + diff --git a/src/content/docs/workers/frameworks/framework-guides/svelte.mdx b/src/content/docs/workers/frameworks/framework-guides/svelte.mdx new file mode 100644 index 00000000000000..5b36acdca8ab05 --- /dev/null +++ b/src/content/docs/workers/frameworks/framework-guides/svelte.mdx @@ -0,0 +1,71 @@ +--- +pcx_content_type: how-to +title: Svelte +sidebar: + badge: Beta +head: [] +description: Create a Svelte application and deploy it to Cloudflare Workers with Workers Assets. +--- + +import { + Badge, + Description, + InlineBadge, + Render, + PackageManagers, +} from "~/components"; + +In this guide, you will create a new [Svelte](https://svelte.dev/) application and deploy to Cloudflare Workers (with the new [ Workers Assets](/workers/configuration/assets/)). + +## 1. Set up a new project + +Use the [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) CLI (C3) to set up a new project. C3 will create a new project directory, initiate Svelte's official setup tool, and provide the option to deploy instantly. + +To use `create-cloudflare` to create a new Svelte project with Workers Assets, run the following command: + + + + + +After setting up your project, change your directory by running the following command: + +```sh +cd my-svelte-app +``` + +## 2. Develop locally + +After you have created your project, run the following command in the project directory to start a local server. This will allow you to preview your project locally during development. + + + +## 3. Deploy your Project + +Your project can be deployed to a `*.workers.dev` subdomain or a [Custom Domain](/workers/configuration/routing/custom-domains/), from your own machine or from any CI/CD system, including Cloudflare's own. + +The following command will build and deploy your project. If you're using CI, ensure you update your ["deploy command"](/workers/ci-cd/builds/build-configuration/#build-settings) configuration appropriately. + + + +--- + +## Bindings + +Your Svelte application can be fully integrated with the Cloudflare Developer Platform, in both local development and in production, by using product bindings. The [Svelte documentation](https://kit.svelte.dev/docs/adapter-cloudflare#runtime-apis) provides information about configuring bindings and how you can access them in your Svelte hooks and endpoints. + +## Static assets + +You can serve static assets your Svelte application by placing them in [the `./static/` directory](https://kit.svelte.dev/docs/project-structure#project-files-static). This can be useful for resource files such as images, stylesheets, fonts, and manifests. + +