Skip to content

Commit

Permalink
Various tweaks, including reordering and copy editing.
Browse files Browse the repository at this point in the history
  • Loading branch information
raphaeltm committed Feb 7, 2024
1 parent 340cb03 commit 0884794
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/defang-byoc.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Defang BYOC
description: Defang allows you deploy services, defined as containers, to your own cloud accounts.
sidebar_position: 000
sidebar_position: 50
---

# Defang BYOC
Expand Down
8 changes: 5 additions & 3 deletions docs/concepts/defang-hosted.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
---
title: Defang Hosted
description: Defang Hosted allows you to get a feel for how Defang works without running production workloads in your own cloud accounts.
sidebar_position: 50
sidebar_position: 00
---

# Defang Hosted

Defang aims to make it easier to deploy your services to the cloud. Specifically, Defang's goal is to make it easier to deploy your workloads to your *own* cloud accounts. We refer to this as bring-your-own-cloud (BYOC) which you can read about in more depth [here](./defang-byoc). We also provide Defang Hosted, but it is only intended for non-production workloads so you can get a feel for how Defang works.
Defang aims to make it easier to deploy your services to the cloud. Specifically, Defang's goal is to make it easier to deploy your workloads to your *own* cloud accounts. We refer to this as bring-your-own-cloud (BYOC) which you can read about in more depth [here](./defang-byoc). We also provide Defang Hosted, but it is only intended for non-production workloads so you can get a feel for how Defang works.

Defang Hosted is a free tier that allows you to deploy services to a Defang-hosted cloud account without needing to manage your own. It is intended for non-production workloads only.

## Limitations

There are a few limitations to Defang Hosted. These limitations are in place to ensure that Defang Hosted is only used for non-production workloads. If you are interested in running production workloads, you should use Defang BYOC.

### No Domain Support
### No Custom Domain Support

When you deploy a service to Defang Hosted, it will be assigned a domain under the `defang.dev` domain. We do not support pointing your own domains to Defang Hosted services.

Expand Down
6 changes: 5 additions & 1 deletion docs/concepts/observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,8 @@ The `defang tail` command will tail the logs for all your services by default. Y
```
defang tail --name my-service
defang tail --etag ua119053ehi2
```
```

## Architecture

In [BYOC](./defang-byoc.md), output is logged to the native logging tools within your cloud provider. The CLI then tails the output as needed.
15 changes: 10 additions & 5 deletions docs/getting-started/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,23 @@ To do pretty much anything with Defang, you'll need to authenticate with the pla
defang login
```

:::info
To learn more about how authentication works in defang, check out the [authenticating page](./authenticating.md).
:::

### Build and Deploy a Service

Defang supports various ways of creating and deploying services to the cloud. The following tutorials dive into each one in more detail:

1. [Generate new code using AI](../tutorials/generate-new-code-using-ai.mdx)
2. [Deploy an existing container using a docker-compose file](../tutorials/deploy-container-using-the-cli.mdx)
3. [Deploy your code using a docker-compose file](../tutorials/deploy-code-compose.mdx)
1. [Create an outline using AI](../tutorials/generate-new-code-using-ai.mdx)
2. [Build and deploy your code](../tutorials/deploy-code-compose.mdx)
3. [Deploy an existing container](../tutorials/deploy-container-using-the-cli.mdx)
4. [Deploy using Pulumi](../tutorials/deploy-using-pulumi.mdx)


### Monitor a Service

By default, all the output (stdout and stderr) from your app is routed through the Defang log cluster. You can view these logs in real-time. You can view logs for all your services, one service, or even one specific deployment of a service.
By default, all the output (stdout and stderr) from your app is logged. You can view these logs in real-time. You can view logs for all your services, one service, or even one specific deployment of a service.

- From the CLI:

Expand All @@ -46,7 +50,8 @@ By default, all the output (stdout and stderr) from your app is routed through t


:::info
Note that the Defang Portal only displays services deployed to Defang Hosted.
* To learn more about observability in Defang, check out the [observability page](../concepts/observability.md).
* Note that the Defang Portal only displays services deployed to Defang Hosted.
:::


Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/deploy-code-compose.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deploy code using a docker-compose file
sidebar_position: 200
title: Build and deploy code
sidebar_position: 100
---

# Deploy Code Using a Docker Compose File
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorials/deploy-container-using-the-cli.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Deploy container using the CLI
sidebar_position: 300
title: Deploy pre-built container
sidebar_position: 200
---

# Deploy container using the CLI
Expand All @@ -23,7 +23,7 @@ services:
# Step 2 - Deploy
```text
defang compose up --tail
defang compose up
```


2 changes: 1 addition & 1 deletion docs/tutorials/deploy-using-pulumi.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Deploy using Pulumi
title: Build and deploy using Pulumi
sidebar_position: 400
---

Expand Down
10 changes: 5 additions & 5 deletions docs/tutorials/generate-new-code-using-ai.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Generate new code using AI
sidebar_position: 100
title: Create an outline using AI
sidebar_position: 50
---

# Generate new code using AI
# Create an outline using AI

Defang supports generating new projects using integration with an AI model. Using this feature, you can describe what you would like the service to do and the CLI will then generate a project skeleton with all the files required to make it work.
Defang supports generating new project outlines using integration with an AI model. Using this feature, you can describe what you would like the service to do and the CLI will then generate a project skeleton with all the files required to make it work.


## Step 1 - Create a new folder for the project
Expand Down Expand Up @@ -35,7 +35,7 @@ This will generate the different files required to start your project based on y
## Step 3 - Review the Code
You can open the files in a code editor to review or make changes as needed before deploying the service.

## Step 4 - Deploy
## Step 4 - Build and Deploy

```bash
defang compose up
Expand Down

0 comments on commit 0884794

Please sign in to comment.