Skip to content

Commit 765bc78

Browse files
committed
keep steps using hypen instead of colon + vllm link
1 parent 5c37f43 commit 765bc78

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

docs/tutorials/deploy-with-gpu.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 500
55

66
# Deploy a GPU-Powered Application With Defang
77

8-
This tutorial guides you to create and deploy a GPU-powered application on AWS using Defang and Mistral. We will walk you through the whole deployment process based on this [Deploying Mistral with vLLM](https://github.com/DefangLabs/defang/tree/main/samples/other/vllm) sample.
8+
This tutorial guides you to create and deploy a GPU-powered application on AWS using Defang and Mistral. We will walk you through the whole deployment process based on this [Deploying Mistral with vLLM](https://github.com/DefangLabs/samples/tree/main/samples/vllm) sample.
99

1010
<iframe width="560" height="315" src="https://www.youtube.com/embed/kynFa2zU7hQ?si=qdV0xa6vkhMFJ6qv" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
1111

@@ -25,11 +25,11 @@ This process can take a few days for AWS to approve.
2525

2626
This sample requires a HugoingFace token to download the model. You can get a token by signing up at [HuggingFace](https://huggingface.co/join) and then going to [your settings](https://huggingface.co/settings/tokens) to get your token.
2727

28-
## Step 1: Clone the sample project
28+
## Step 1 - Clone the sample project
2929

30-
You'll need to clone [this sample](https://github.com/DefangLabs/defang/tree/main/samples/other/vllm) to go through this tutorial.
30+
You'll need to clone [this sample](https://github.com/DefangLabs/samples/tree/main/samples/vllm) to go through this tutorial.
3131

32-
## Step 2: Check your [Defang BYOC](../concepts/defang-byoc.md) settings
32+
## Step 2 - Check your [Defang BYOC](../concepts/defang-byoc.md) settings
3333

3434
* Make sure you [install the latest version of the Defang CLI](../getting-started/installing.md)
3535
* Then, make sure you have properly [authenticated your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). The Defang CLI makes use of AWS environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`, so make sure the correct values are set for those.
@@ -40,7 +40,7 @@ aws sts get-caller-identity
4040
```
4141

4242

43-
## Step 2: Prepare your Environment
43+
## Step 3 - Prepare your Environment
4444
* Log into your Defang account
4545
```bash
4646
defang login
@@ -54,7 +54,7 @@ defang config set --name HF_TOKEN
5454
[Configuration](../concepts/configuration.md) stores your sensitive information such as API keys, passwords, and other credentials for you.
5555

5656

57-
## Step 3: Explore the Compose File
57+
## Step 4 - Explore the Compose File
5858

5959
The `compose.yml` file is where you define your services and their configurations.
6060

@@ -153,10 +153,10 @@ You can see here how Defang's [networking](../concepts//networking.mdx) works. T
153153
```
154154

155155

156-
## Step 4: Deploy to Your Own AWS Account with Defang
156+
## Step 5 - Deploy to Your Own AWS Account with Defang
157157

158158
Run the following command to deploy your service:
159159

160160
```bash
161-
defang compose up
161+
defang compose up --provider=aws
162162
```

docs/tutorials/use-your-own-domain-name.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In our latest version of [Defang BYOC](https://docs.defang.io/docs/concepts/defa
1010
<iframe width="560" height="315" src="https://www.youtube.com/embed/n4RlMpsdTbs?si=_Ru6tobSbi9LT4Q1" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
1111

1212

13-
## Step 1 : Check your [Defang BYOC](../concepts/defang-byoc.md) settings
13+
## Step 1 - Check your [Defang BYOC](../concepts/defang-byoc.md) settings
1414

1515
* Make sure you [install the latest version of the Defang CLI](../getting-started/installing.md)
1616
* Then, make sure you have properly [authenticated your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html). The Defang CLI makes use of AWS environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`, so make sure the correct values are set for those.
@@ -21,7 +21,7 @@ aws sts get-caller-identity
2121
```
2222

2323

24-
## Step 2: Setup a Hosted Zone in AWS Route 53
24+
## Step 2 - Setup a Hosted Zone in AWS Route 53
2525

2626
:::info
2727
**If you purchased your domain with AWS, you can skip this step.**
@@ -32,7 +32,7 @@ For Defang to be able to manage your domain, you need to create a [public hosted
3232
<img src="/img/domains-tutorial/zone.png" alt="Hosted Zone UI Screenshot" style={{maxWidth: 650}} />
3333

3434

35-
## Step 3: Configure your DNS settings in your domain registrar
35+
## Step 3 - Configure your DNS settings in your domain registrar
3636

3737
:::info
3838
**If you purchased your domain with AWS, you can skip this step.**
@@ -43,7 +43,7 @@ You'll need to create NS records in your domain registrar that point to the AWS
4343
![CloudFlare NS Records Screenshot](/img/domains-tutorial/ns-records.png)
4444

4545

46-
## Step 4: Set up Your Compose File
46+
## Step 4 - Set up Your Compose File
4747
In your compose file, specify the domain name you want to use, for example
4848

4949
```yaml
@@ -59,7 +59,7 @@ services:
5959
```
6060
6161
62-
## Step 5: Deploy
62+
## Step 5 - Deploy
6363
Run the following command to deploy your service:
6464
```bash
6565
defang compose up

docs/tutorials/using-codespaces-gitpod.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,69 +3,69 @@ title: Using Codespaces and Gitpod
33
sidebar_position: 700
44
---
55

6-
# Defang with Codespaces and GitPod
6+
# Defang With Codespaces and GitPod
77

88
<iframe width="560" height="315" src="https://www.youtube.com/embed/71pmCfLdxTg?si=Q9YIESYEUNTBFBIy" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
99

1010
This tutorial will guide you to set up Defang in both Codespaces and Gitpod.
1111

1212
## Getting Started with Github Codespaces and Defang
1313

14-
### Step 1: Clone the Defang Codespace Project
14+
### Step 1 - Clone the Defang Codespace Project
1515
Start by cloning the [Defang Github-Codespace](https://github.com/DefangLabs/github-codespace) repo and pushing it to your own account. This repository is configured with a Codespace that has Defang pre-installed.
1616

1717

18-
### Step 2: Create a Codespace
18+
### Step 2 - Create a Codespace
1919
Once you've pushed to your own GitHub repo, you'll be able to create a Codespace by clicking the Code button, selecting the Codespaces tab, and clicking the + icon. This will set up a development environment with Defang already installed, which might take a few minutes.
2020

2121
![Create Codespace button screenshot](/img/codespace-tutorial/new-codespace.png)
2222

2323

24-
### Step 3: Open in VS Code Desktop
24+
### Step 3 - Open in VS Code Desktop
2525
For the `defang login` command to work correctly, you must open the Codespace in VS Code desktop. This is required because the login process is designed to run on localhost.
2626

2727

2828
![Open in vs code desktop button screenshot](/img/codespace-tutorial/desktop.png)
2929

3030

31-
### Step 4: Run Defang Login
31+
### Step 4 - Run Defang Login
3232
Within a VS Code desktop terminal, execute the following command.
3333
```bash
3434
defang login
3535
```
3636
Although it may initially refuse to connect on your localhost, going back will show a "successfully logged in" message, confirming that you're logged into Defang.
3737

3838

39-
### Step 5: Verify Running Services
39+
### Step 5 - Verify Running Services
4040
Now that you're logged in, you can use Defang commands. You can test that everything is working properly by running `defang ls` to list your running services.
4141

4242

4343
## Getting Started with GitPod Workspace with Defang
4444

45-
### Step 1: Clone the Defang GitPod Workspace Project
45+
### Step 1 - Clone the Defang GitPod Workspace Project
4646
Start by cloning the [Defang Gitpod-Workspace](https://github.com/DefangLabs/gitpod-workspace) repo and pushing it to your own GitHub, GitLab, or BitBucket account. This repository includes a Workspace configuration that pre-installs Defang.
4747

4848

49-
### Step 2: Initialize GitPod Workspace
49+
### Step 2 - Initialize GitPod Workspace
5050
Navigate `https://gitpod.io/#<your-repo-url>` to create your new workspace.
5151
In the repository, we have a yaml file indicating that we are using a pre-built dockerfile which installs Defang CLI for you.
5252

5353

54-
### Step 3: Lauch VS Code from GitPod
54+
### Step 3 - Lauch VS Code from GitPod
5555
Open VS Code from GitPod, you will likely need to have the GitPod VS Code extension installed.
5656

5757
![Open in vs code desktop button screenshot](/img/codespace-tutorial/gitpod-desktop.png)
5858

5959
![Screenshot of GitPod extension](/img/codespace-tutorial/gitpod-ext.png)
6060

6161

62-
### Step 4: Run Defang Login
62+
### Step 4 - Run Defang Login
6363
Within a VS Code desktop terminal, execute the following command.
6464

6565
```bash
6666
defang login
6767
```
6868

6969

70-
### Step 5: Verify Running Services
70+
### Step 5 - Verify Running Services
7171
Now that you're logged in, you can use Defang commands. You can test that everything is working properly by running `defang ls` to list your running services.

0 commit comments

Comments
 (0)