-
Notifications
You must be signed in to change notification settings - Fork 6
Added 1-Click Deploy tutorial #160
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
dc508a6
Add 1-Click Deploy docs
commit111 0c48eb2
add config section
commit111 e7af3cf
Update docs/providers/playground.md
commit111 4826b91
apply code review changes
commit111 1e6025b
Merge branch 'linda-one-click-deploy' of https://github.com/DefangLab…
commit111 0580a74
add custom 1-click deploy to your app tutorial
commit111 0bd7323
apply code review changes
commit111 9694d97
capitalize "action" in github action
commit111 76f276f
add images to regular 1-click deploy tutorial
commit111 07b3047
refine regular 1-click deploy tutorial
commit111 47b18f0
add arrow to an image
commit111 f32b98c
increase level of one-click deploy tutorial
commit111 6575642
Apply suggestions from code review
commit111 1ac594b
Apply suggestions from code review
commit111 c9b98f9
Update docs/tutorials/using-one-click-deploy.md
commit111 a184700
small fix
commit111 64e8750
revamp custom 1-click tutorial
commit111 2dcca7a
Merge branch 'linda-one-click-deploy' of https://github.com/DefangLab…
commit111 f053446
fix to first sentence
commit111 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
title: Using 1-Click Deploy | ||
sidebar_position: 800 | ||
description: Use 1-Click Deploy to easily deploy a sample to the Defang Playground. | ||
--- | ||
|
||
# Using 1-Click Deploy | ||
|
||
This tutorial will show you how to use Defang 1-Click Deploy to deploy a sample. | ||
|
||
The 1-Click Deploy button is intended to be a quickstart way for new users to deploy to the [Defang Playground](/docs/concepts/defang-playground) with no prior installation needed. | ||
commit111 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
:::info | ||
If this is not your first time, we recommend using the [Defang CLI](/docs/getting-started) to get a full experience of deploying with Defang. | ||
commit111 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
::: | ||
|
||
## Step 1 - Choose a Sample | ||
Head to our [list of samples](https://defang.io/#samples) and click a sample you want to deploy. Then, click on the button that says "1-Click Deploy". | ||
|
||
Alterntively, you can find the "1-Click Deploy" button located in the `README.md` file of each sample's repository. | ||
|
||
## Step 2 - Allow Permissions | ||
|
||
After you've clicked, you will be prompted to use GitHub to log in. Once you see a "Create a Repository" page appear, allow the sample repository to get cloned into your GitHub account. | ||
|
||
## Step 3 - Wait for Deployment to Complete | ||
|
||
A Github action workflow will automatically start running to install Defang and deploy the sample to the Defang Playground. If you wish to, you can see this by going into the "Actions" tab in your GitHub repository. | ||
commit111 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
You can view the status of your deployment in the [Defang Portal](https://portal.defang.dev/), or by downloading the [Defang CLI](/docs/getting-started). | ||
|
||
:::tip | ||
Defang has a tutorial on how you can [monitor your services](/docs/tutorials/monitoring-your-services). | ||
::: | ||
|
||
:::info | ||
If you decide to make a commit later to a repository created from 1-Click Deploy, then the project will automatically get deployed again to Defang Playground. | ||
::: | ||
|
||
### Configuration in 1-Click Deploy | ||
|
||
If the sample you chose requires setting configuration, such as API keys, you can set sensitive config values as secrets in your GitHub repository and the action will automatically deploy them for you. | ||
commit111 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.