Skip to content

Commit 0bd7323

Browse files
committed
apply code review changes
1 parent 0580a74 commit 0bd7323

File tree

1 file changed

+5
-20
lines changed

1 file changed

+5
-20
lines changed

docs/tutorials/adding-custom-one-click-deploy.md

Lines changed: 5 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,6 @@ This tutorial will show you how to add a custom Defang 1-Click Deploy button to
1212
This page focuses on adding 1-Click Deploy to any app that is not from [our list of samples](https://defang.io/#samples). We have a separate tutorial on [how to use 1-Click Deploy](/docs/tutorials/using-one-click-deploy) for Defang's pre-made samples, which is meant for new users.
1313
:::
1414

15-
<!--
16-
0. have a project ready,
17-
1. get the deploy.yaml action (and set configs as needed)
18-
2. get the compose.yaml for project and put in root folder
19-
3. click "template repo" in settings github
20-
4. get the url (encoded version) of this template repo ready for making a new 1-click deployment instance
21-
https://portal.defang.dev/redirect?url=<encoded url>&name=your-project-name
22-
this goes thru portal in order for the person deploying to get logged into defang
23-
https://www.urlencoder.io/ can use this encoder
24-
5. paste it into the readme/button
25-
-->
26-
27-
2815
## Step 1 - Have an App Ready
2916

3017
The button we will be creating in this tutorial will allow any user to deploy your app to their Defang account. If your app is ready to be deployed with Defang (i.e. has a valid `compose.yaml` file), you can skip this step.
@@ -87,26 +74,26 @@ jobs:
8774
8875
## Step 3 - Use a Template GitHub Repository
8976
90-
You have the option of using Defang's template repo or your own template GitHub Repo for this step. There is no difference in end result, but it may be easier to use Defang's template repo so that you do not have to create your own.
77+
You have the option of using Defang's template repo or your own template GitHub repo for this step. There is no difference in end result, but it may be easier to use Defang's template repo so that you do not have to create your own.
9178
9279
### Option 1 - Use an Existing Template Repo
9380
94-
1. Click the link to [Defang's 1-Click Template Repo](https://github.com/DefangLabs/1-click-template), or open an existing template repo if you have one.
81+
1. Click the link to [Defang's 1-Click template repo](https://github.com/DefangLabs/1-click-template), or open an existing template repo if you have one.
9582
2. Click the dropdown menu next to the green "Use this template" button near the top right corner, then click "Create a new repository":
9683
9784
![use-this-template](/img/custom-one-click-tutorial/use-this-template.png)
9885
99-
4. You will be taken to a page similar to the one shown below. Then, enter a name for your repository and click the green "Create repository" button at the bottom.
86+
3. You will be taken to a page similar to the one shown below. Then, enter a name for your repository and click the green "Create repository" button at the bottom.
10087
10188
![create-a-new-repo](/img/custom-one-click-tutorial/create-a-new-repo.png)
10289
103-
5. Now that you've created a new repository from a template repo, you can move onto the next step, which is getting the encoded URL.
90+
4. Now that you've created a new repository from a template repo, you can move onto the next step, which is getting the encoded URL.
10491
10592
### Option 2 - Manually Set Up a Template Repo
10693
10794
1. Create a new repository on GitHub.
10895
2. Go to the repository's "Settings", seen near the right on the top bar.
109-
3. Select the "Template Repository" box to turn your repo into a template repo, as seen below:
96+
3. Select the "Template repository" box to turn your repo into a template repo, as seen below:
11097
11198
![select-template-repo-box](/img/custom-one-click-tutorial/select-template-repo-box.png)
11299
@@ -140,10 +127,8 @@ The finished link should look similar to the one below:
140127
https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2F<your-github-username>%2F<your-project-here>&name=<your-project-here>
141128
```
142129

143-
144130
Now you have a link for anyone to deploy your app to Defang, with just 1 click!
145131

146-
147132
### Examples
148133
For example, you can add it as a link in a Markdown file:
149134
```

0 commit comments

Comments
 (0)