Skip to content

Commit 4dbcecc

Browse files
authored
Merge pull request #129 from DefangLabs/linda-docs-4
Improved some docs pages
2 parents 5b81520 + 1c85f2a commit 4dbcecc

File tree

3 files changed

+57
-13
lines changed

3 files changed

+57
-13
lines changed

docs/intro/what-is-defang.mdx

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,29 @@ description: What is Defang?
88

99
<iframe width="560" height="315" src="https://www.youtube.com/embed/afglsBYieuc?si=iKgUX4ejz7AixxqQ" 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 style={{marginBottom: "2rem"}}></iframe>
1010

11-
Defang is a radically simpler way for developers to develop, deploy, and debug their cloud applications. Defang enables you to easily author cloud application in any language, build and deploy to the cloud with a single command, and iterate quickly with AI-assisted tooling.
11+
## A Tool to Develop, Debug, Deploy
1212

13-
- The [Defang CLI](/docs/getting-started#install-the-defang-cli.md) includes an AI-driven agent that translates natural language prompts to an outline for your project that you can then refine.
14-
- Defang can automatically build and deploy your project with a single command.
15-
- If you’re new to Defang, you can try deploying to the [Defang Playground](/docs/concepts/defang-playground.md), a hosted environment to learn to use Defang with non-production workloads.
16-
- Once you’re ready, you can [deploy](/docs/concepts/deployments.md) it to your own cloud account - we call this [Defang BYOC](/docs/concepts/defang-byoc.md). Defang takes care of all the heavy lifting such as configuring networking, security, [observability](/docs/concepts/observability.md) and all the other details that usually slow down the average cloud developer.
17-
- You can also use Defang to easily [publish updates](/docs/concepts/deployments.md#deploying-updates) to your deployed application with zero downtime.
13+
Defang is a radically simpler way for developers to develop, deploy, and debug their cloud applications. Defang enables you to easily author cloud applications in any language, build and deploy to the cloud with a single command, and iterate quickly with AI-assisted tooling.
14+
15+
### Develop
16+
17+
The [Defang CLI (command line interface)](/docs/getting-started#install-the-defang-cli.md) includes an AI-driven agent that translates natural language prompts to [generate an outline](/docs/tutorials/generate-new-code-using-ai) for your project that you can then refine.
18+
19+
### Deploy
20+
21+
Defang can automatically build and deploy your project with a single command.
22+
23+
- If you’re new to Defang, you can try deploying to [Defang Playground](/docs/concepts/defang-playground.md), a hosted environment to learn to use Defang with non-production workloads.
24+
- Once you’re ready, you can [deploy](/docs/tutorials/deploy-to-your-cloud) a project to your own cloud account - we call this [Defang BYOC (Bring-your-Own-Cloud)](/docs/concepts/defang-byoc.md). We offer support for the following cloud providers:
25+
* [Amazon Web Services (AWS)](/docs/tutorials/deploy-to-aws)
26+
* [DigitalOcean](/docs/tutorials/deploy-to-digitalocean)
27+
* [Google Cloud Platform (GCP)](/docs/tutorials/deploy-to-gcp)
28+
- To support stateful workloads, we've got managed storage options such as [Managed Postgres](/docs/concepts/managed-storage/managed-postgres) and [Managed Redis](/docs/concepts/managed-storage/managed-redis).
29+
- If you want, you can also [bring your own domain name](docs/tutorials/use-your-own-domain-name) for your deployment.
30+
31+
Defang takes care of all the heavy lifting such as configuring networking, security, [observability](/docs/concepts/observability.md) and all the other details that usually slow down the average cloud developer.
32+
It also allows you to easily [publish updates](/docs/concepts/deployments.md#deploying-updates) to your deployed application with zero downtime.
33+
34+
### Debug
35+
36+
Once you've deployed, you can use our AI agent to help [debug](/docs/concepts/debug) your cloud applications, using your service logs and project files to help you identify and resolve issues.

docs/tutorials/deploy-container-using-the-cli.mdx

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,48 @@ sidebar_position: 200
55

66
# Deploy Existing Containers
77

8-
This example is useful if you already have a Docker container built manually or through a CI/CD system and have that the resulting image is available in a public or private repository accessible by Defang.
8+
This tutorial will show you how to deploy an existing container/multi-container application.
9+
10+
This example is rather useful if you already have a Docker container built manually, or through a CI/CD system where the resulting image is available in a public or private repository accessible by Defang.
11+
But it is not required in order to follow along to this tutorial.
12+
13+
# Step 1 - Make a Docker Compose file
14+
:::tip
15+
If you are unfamiliar with Docker Compose files, check out the [Compose](/docs/concepts/compose) page.
16+
:::
17+
Create a `compose.yaml` file to define the [service(s)](/docs/concepts/services) in your application.
18+
19+
If you already have a Docker Compose file to define your service(s), you can use it directly and skip this step.
920

10-
# Step 1 - Docker Compose
11-
If you already have a Docker Compose file for your service(s) you can use it directly. Else you can create one like this:
1221

1322
```yaml
1423
version: '3.9'
1524
services:
16-
service1:
17-
# This is just an example, replace with the image you want
18-
image: "docker.io/nginx:latest"
25+
web:
26+
image: nginx:latest
1927
ports:
2028
- mode: ingress
2129
target: 3000
30+
app:
31+
build:
32+
context: .
33+
dockerfile: Dockerfile
34+
ports:
35+
- mode: ingress
36+
target: 4000
37+
redis:
38+
image: redis:6.2
39+
restart: unless-stopped
40+
ports:
41+
- mode: host
42+
target: 6379
2243
```
2344
45+
The example above shows a multi-container application with 3 services, `web`, `app`, `redis`.
46+
If you wanted to deploy only one container, say `app`, then the example would remain the same, except without the `web` and `redis` services.
47+
2448
# Step 2 - Deploy
49+
Run the following command in the [Defang CLI]((/docs/getting-started#install-the-defang-cli.md)).
2550
```text
2651
defang compose up
2752
```

docs/tutorials/deploy-to-playground.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 15
66

77
# Deploy to Playground
88

9-
This tutorial will show you how to deploy your project to the free Defang Playground.
9+
This tutorial will show you how to deploy your project to the free [Defang Playground](/docs/concepts/defang-playground).
1010

1111
## Pre-requisites
1212
* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)

0 commit comments

Comments
 (0)