Skip to content

Commit 44f57a6

Browse files
qk7bwolfenrainalestiago
authored
docs: update deploy pages's subtitles to make it clear and consistent (#1237)
Co-authored-by: Jochum van der Ploeg <[email protected]> Co-authored-by: Alejandro Santiago <[email protected]>
1 parent 159a446 commit 44f57a6

File tree

4 files changed

+44
-16
lines changed

4 files changed

+44
-16
lines changed

docs/docs/deploy/aws-app-runner.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,19 @@ aws ecr create-repository --repository-name [REPOSITORY_NAME]
5252

5353
## Deploying
5454

55-
1. Build your API for production use by running:
55+
### 1. Build your API for production use
56+
57+
Simply run:
5658

5759
```bash
5860
dart_frog build
5961
```
6062

6163
This will create a /build directory with all the files needed to deploy your API.
6264

63-
2. Build your API using Docker by running:
65+
### 2. Build your API using Docker
66+
67+
In order to build a Docker image, you can run this command:
6468

6569
```bash
6670
docker build build \
@@ -72,19 +76,25 @@ docker build build \
7276
- `[REPOSITORY_NAME]`: The name of the repository you created earlier
7377
- `[IMAGE_TAG]`: A name given to this image to identify it in the repository
7478

75-
This command will build the Docker image on your computer and can take a few seconds to a few minutes.
79+
It will build the Docker image on your computer, this can take a few seconds to a few minutes.
80+
81+
### 3. Push the image to ECR
7682

77-
3. Push the image to ECR by running:
83+
Now that you have the image on your computer, you can push it to ECR:
7884

7985
```bash
8086
docker push [AWS_ACCOUNT_ID].dkr.ecr.[REGION].amazonaws.com/[REPOSITORY_NAME]:[IMAGE_TAG]
8187
```
8288

8389
You should now see your repository in the [ECR console](https://console.aws.amazon.com/ecr)
8490

85-
4. Create your App Runner service following [these instructions](https://docs.aws.amazon.com/apprunner/latest/dg/manage-create.html#:~:text=Create%20a%20service%20from%20an%20Amazon%20ECR%20image). Look for the `Create a service from an Amazon ECR image` section.
91+
### 4. Create your App Runner Service
92+
93+
Follow [these instructions](https://docs.aws.amazon.com/apprunner/latest/dg/manage-create.html#:~:text=Create%20a%20service%20from%20an%20Amazon%20ECR%20image). Look for the `Create a service from an Amazon ECR image` section.
94+
95+
### 5. Enjoy your API on AWS!
8696

87-
5. Congratulations! 🎉 You have successfully built and deployed your API to App Runner. You can now access your API at the Default domain on the [App Runner console](https://console.aws.amazon.com/apprunner)
97+
Congratulations 🎉, you have successfully built and deployed your API to App Runner. You can now access your API at the Default domain on the [App Runner console](https://console.aws.amazon.com/apprunner)
8898

8999
## Additional Resources
90100

docs/docs/deploy/digital-ocean-app-platform.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,19 @@ Be creative - registry names must be unique across all Digital Ocean container r
6565

6666
## Deploying
6767

68-
1. Build your API for production use by running:
68+
### 1. Build your API for production use
69+
70+
Simply run:
6971

7072
```bash
7173
dart_frog build
7274
```
7375

7476
This will create a `/build` directory with all the files needed to deploy your API.
7577

76-
2. Build your API using Docker by running:
78+
### 2. Build your API using Docker
79+
80+
In order to build a Docker image, you can run this command:
7781

7882
```bash
7983
docker build build \
@@ -95,17 +99,21 @@ For example, if you build on an M1 CPU, the generated image will not be able to
9599
We recommend using an automated workflow via GitHub Actions to automate deployments and ensure a consistent environment when building your image.
96100
:::
97101

98-
3. Push the image to Container Registry by running:
102+
### 3. Push the image to Container Registry
99103

100104
```bash
101105
docker push registry.digitalocean.com/[REGISTRY]/[IMAGE_NAME]
102106
```
103107

104108
You should now see your repository in the [Container Registry page](https://cloud.digitalocean.com/registry)
105109

106-
4. Create your App by following [these instructions](https://docs.digitalocean.com/products/app-platform/how-to/deploy-from-container-images/#deploy-resource-using-a-container-image-as-the-source).
110+
### 4. Create your App
111+
112+
Create an application on Digital Ocean by following [these instructions](https://docs.digitalocean.com/products/app-platform/how-to/deploy-from-container-images/#deploy-resource-using-a-container-image-as-the-source).
113+
114+
### 5. Enjoy your API on Digital Ocean!
107115

108-
5. Congratulations! You have successfully built and deployed your API to App Platform. You can now access your API via the URL at the top of the app’s overview page 🎉
116+
Congratulations 🎉, you have successfully built and deployed your API to App Platform. You can now access your API via the URL at the top of the app’s overview page 🎉
109117

110118
## Additional Resources
111119

docs/docs/deploy/globe.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,17 @@ globe login
2525

2626
## Deploying
2727

28-
1. Deploy your API for production use by running:
28+
### 1. Deploy your API for production
29+
30+
In order to deploy, you can simply run:
2931

3032
```bash
3133
globe deploy --prod
3234
```
3335

34-
2. Congratulations! 🎉 You have successfully deployed your API to Globe. You can now access your API at the Deployment URL that is available through the Globe dashboard.
36+
### 2. Enjoy your API on Globe!
37+
38+
Congratulations 🎉, you have successfully built and deployed your API on Globe. You can now access your API at the Deployment URL that is available through the Globe dashboard.
3539

3640
## Additional Resources
3741

docs/docs/deploy/google-cloud-run.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,19 @@ gcloud auth login
3333

3434
## Deploying
3535

36-
1. Build your API for production use by running:
36+
### 1. Build your API for production use
37+
38+
Simply run:
3739

3840
```bash
3941
dart_frog build
4042
```
4143

4244
This will create a `/build` directory with all the files needed to deploy your API.
4345

44-
2. Deploy your API to Cloud Run by running:
46+
### 2. Deploy your API to Cloud Run
47+
48+
In order to deploy to Cloud Run, you can run the following command:
4549

4650
```bash
4751
gcloud run deploy [SERVICE_NAME] \
@@ -65,7 +69,9 @@ Running this command will do three things:
6569
- Build the Docker image in [Cloud Build](https://cloud.google.com/build) and upload it to [Artifact Registry](https://cloud.google.com/artifact-registry)
6670
- Deploy the image to the specified Cloud Run service
6771

68-
3. Congratulations! 🎉 You have successfully built and deployed your API to Cloud Run. You can now access your API at the Service URL that is printed in the last line of output.
72+
### 3. Enjoy your API on Cloud Run!
73+
74+
Congratulations 🎉, you have successfully built and deployed your API to Cloud Run. You can now access your API at the Service URL that is printed in the last line of output.
6975

7076
:::note
7177
If you have not already enabled the necessary Google Cloud APIs to deploy your API, `gcloud` can enable them for you. Just select `Y` when prompted.

0 commit comments

Comments
 (0)