rough provider tutorials

jordanstephens · jordanstephens · commit f8f81dac4b07 · 2024-11-26T11:59:49.000-08:00
diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md
@@ -102,11 +102,11 @@ Congratulations! You've successfully deployed your first service with Defang. No
 
 Defang supports various ways of creating and deploying services to the cloud. The following tutorials dive into each one in more detail:
 
+1. [Deploy to your own cloud](/docs/tutorials/deploy-to-your-cloud)
 1. [Update the code and redeploy](/docs/getting-started/build-and-deploy)
-2. [Monitor your services](/docs/getting-started/monitor)
-3. [Deploy an outline using AI](/docs/tutorials/generate-new-code-using-ai)
-4. [Build and deploy your code](/docs/tutorials/deploy-code-compose)
-5. [Deploy existing containers](/docs/tutorials/deploy-container-using-the-cli)
-6. [Deploy using Pulumi](/docs/tutorials/deploy-using-pulumi)
+1. [Monitor your services](/docs/getting-started/monitor)
+1. [Deploy an outline using AI](/docs/tutorials/generate-new-code-using-ai)
+1. [Deploy existing containers](/docs/tutorials/deploy-container-using-the-cli)
+1. [Deploy using Pulumi](/docs/tutorials/deploy-using-pulumi)
 
 Choose the direction that seems the most interesting. If you have any questions, join the [Defang Discord](https://discord.gg/defang) and we'll be happy to help you out.
diff --git a/docs/providers/digitalocean/digitalocean.md b/docs/providers/digitalocean/digitalocean.md
@@ -13,17 +13,33 @@ This feature is available for Public Preview as of October 2024. This page will
 Why should you use Defang with DigitalOcean? Defang allows you to easily create and manage full, scalable applications with DigitalOcean. Defang aims to make it easier to deploy your services to the cloud. DigitalOcean is one of the most popular cloud providers in the world and with Defang, you dont have to waste your time understanding the complexities and challenges of the DigitalOcean platform. Let Defang do it for you and spend more time working on whats important to you!
 
 ## Getting Started
-To get started with the Defang BYOC DigitalOcean Provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang). Next make sure you have signed up for a [DigitalOcean account](https://try.digitalocean.com/freetrialoffer/).  
 
-After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/) as well as your [Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/).  Next, save these values as environment variables with the names `DIGITALOCEAN_TOKEN`, `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY`. 
+### Install Defang
+
+To get started with the Defang BYOC DigitalOcean Provider, first [install the latest version of the Defang CLI](../getting-started#authenticate-with-defang).
+
+### Sign up for DigitalOcean
+Next make sure you have signed up for a [DigitalOcean account](https://try.digitalocean.com/freetrialoffer/).
+
+### Authenticate with DigitalOcean
+After signing up for your account, be sure to setup your [personal access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/). Defang will need to find this value in your shell as the `DIGITALOCEAN_TOKEN` environment variable.
+
+### Authenticate with DigitalOcean Spaces
+You will also need a [Digital Ocean Spaces access key](https://docs.digitalocean.com/products/spaces/how-to/manage-access/). Defang will need to find this value in your shell as the `SPACES_ACCESS_KEY_ID`, and `SPACES_SECRET_ACCESS_KEY` environment variables.
+
+### Configure your shell environment
 
 ```bash
 export DIGITALOCEAN_TOKEN=<your-token>
 export SPACES_ACCESS_KEY_ID=<your-key-id>
 export SPACES_SECRET_ACCESS_KEY=<your-key>
 ```
 
-The Defang CLI will automatically check if they are set before running. Once you are ready to go, add the `--provider=digitalocean` to your command to tell the Defang CLI to use the DigitalOcean provider.
+The Defang CLI will automatically check if these envinonment variables are set before running.
+
+### Deploy your project to DigitalOcean
+
+Once you are ready to go, add the `--provider=digitalocean` to your command to tell the Defang CLI to use the DigitalOcean provider.
 
 ```bash
 $ defang up --provider=digitalocean
@@ -33,7 +49,7 @@ $ export DEFANG_PROVIDER=digitalocean
 
 ## Region
 
-The Defang BYOC DigitalOcean Provider will use the region specified in the `REGION` environment variable. For a list of regions available in DigitalOcean, see the [region documentation](https://docs.digitalocean.com/platform/regional-availability/#app-platform-availability). 
+The Defang BYOC DigitalOcean Provider will use the region specified in the `REGION` environment variable. For a list of regions available in DigitalOcean, see the [region documentation](https://docs.digitalocean.com/platform/regional-availability/#app-platform-availability).
 
 ## Architecture
 
@@ -45,7 +61,7 @@ To deploy your services, the Defang CLI packages your code and uploads it to a [
 
 ### Runtime
 
-The Provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/). 
+The Provider runs your workloads using the [DigitalOcean App Platform](https://docs.digitalocean.com/products/app-platform/).
 
 ### Secrets
 
diff --git a/docs/tutorials/deploy-to-aws.mdx b/docs/tutorials/deploy-to-aws.mdx
@@ -0,0 +1,49 @@
+---
+title: Deploy to Amazon Web Services (AWS) with Defang
+description: Defang allows you deploy to your own Amazon Web Services (AWS) account.
+sidebar_position: 10
+---
+
+# Deploying to Amazon Web Services (AWS) with Defang
+
+This tutorial will show you how to deploy your services to your own AWS account using Defang.
+
+## Pre-requisites
+* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
+* [A `compose.yaml` file in your project](/tutorials/writing-a-compose-file)
+* [A Defang Account](/getting-started/authenticating)
+* [The Defang CLI](/getting-started/installing)
+* [AWS Account Credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html)
+
+## Deploy your project to AWS
+
+1. Navigate to the directory where your project is located:
+```bash
+$ cd path/to/your/project
+```
+
+2. Authenticate Defang to use your AWS Account
+
+Defang will look for your AWS credentials in your shell environment.
+
+Defang will expect to find one of the following credential sets:
+* the `AWS_PROFILE` environment variable
+* or, the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
+
+3. Deploy
+
+Invoke the `defang up` CLI command with the `--provider=aws` flag or set the `DEFANG_PROVIDER=aws` environment variable.
+
+For example:
+
+```bash
+$ defang up --provider=aws
+```
+
+4. Inspect your deployment
+
+Defang will provision resources in your AWS account and deploy your services. You can inspect the resources created in your AWS dashboard.
+
+***
+
+For a deeper discussion of the Defang AWS Architecture, including a list of the resources we provision in your account, see our [AWS Provider docs](./providers/aws/aws.md).
diff --git a/docs/tutorials/deploy-to-digitalocean.mdx b/docs/tutorials/deploy-to-digitalocean.mdx
@@ -0,0 +1,50 @@
+---
+title: Deploy to Digital Ocean with Defang
+description: Defang allows you deploy to your own Digital Ocean account.
+sidebar_position: 10
+---
+
+# Deploying to Digital Ocean with Defang
+
+This tutorial will show you how to deploy your services to your own Digital Ocean account using Defang.
+
+## Pre-requisites
+* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
+* [A `compose.yaml` file in your project](/tutorials/writing-a-compose-file)
+* [A Defang Account](/getting-started/authenticating)
+* [The Defang CLI](/getting-started/installing)
+* [Digital Ocean Account Credentials](/providers/digitalocean#getting-started)
+* [Digital Ocean Spaces Access Keys](/providers/digitalocean#getting-started)
+
+## Deploy your project to Digital Ocean
+
+1. Navigate to the directory where your project is located:
+```bash
+$ cd path/to/your/project
+```
+
+2. Authenticate Defang to use your Digital Ocean Account
+
+Defang will look for your Digital Ocean credentials in your shell environment.
+
+Defang will expect to find the following credentials:
+* the `DIGITALOCEAN_TOKEN` environment variable
+* and, the `SPACES_ACCESS_KEY_ID` and `SPACES_SECRET_ACCESS_KEY` environment variables
+
+3. Deploy
+
+Invoke the `defang up` CLI command with the `--provider=do` flag or set the `DEFANG_PROVIDER=do` environment variable.
+
+For example:
+
+```bash
+$ defang up --provider=do
+```
+
+4. Inspect your deployment
+
+Defang will provision resources in your Digital Ocean account and deploy your services. You can inspect the resources created in your Digital Ocean dashboard.
+
+***
+
+For a deeper discussion of the Defang Digital Ocean Architecture, see our [Digital Ocean Provider docs](./providers/digitalocean/digitalocean.md).
diff --git a/docs/tutorials/deploy-to-gcp.mdx b/docs/tutorials/deploy-to-gcp.mdx
@@ -0,0 +1,9 @@
+---
+title: Deploy to Google Cloud Platform (GCP) with Defang
+description: Defang allows you deploy to your own Google Cloud Platform (GCP) account.
+sidebar_position: 10
+---
+
+# Deploying to Google Cloud Platform (GCP) with Defang
+
+Coming soon!
diff --git a/docs/tutorials/deploy-to-your-cloud.mdx b/docs/tutorials/deploy-to-your-cloud.mdx
@@ -0,0 +1,22 @@
+---
+title: Deploy to your cloud with Defang
+description: Defang allows you deploy to your own cloud account.
+sidebar_position: 10
+---
+
+# Deploying to your cloud with Defang
+
+This tutorial will show you how to deploy your services to your own cloud account using Defang.
+
+::: tip
+::: Defang makes it easier to deploy to any cloud—in your *own* cloud accounts. We refer to this as bring-your-own-cloud (BYOC).
+:::
+::: If you aren't ready to deploy to your own cloud account, you can use the Defang Playground to get a feel for how Defang works for free.
+
+## Choose your cloud
+
+The first step is to choose which cloud provider you want to deploy to. Defang supports the following cloud providers:
+
+* [AWS](./tutorials/deploy-to-aws)
+* [DigitalOcean](./tutorials/deploy-to-digitalocean)
+* [GCP](./tutorials/deploy-to-gcp)
diff --git a/docs/tutorials/writing-a-compose-file.mdx b/docs/tutorials/writing-a-compose-file.mdx
@@ -0,0 +1,8 @@
+---
+title: Writing a Compose file
+sidebar_position: 500
+---
+
+# Writing a Compose file
+
+A Compose file is a YAML file that describes the services, networks, and volumes that make up your application. Defang uses this file to deploy your services.
