Merge pull request #128 from DefangLabs/linda-docs-3

commit111 · web-flow · commit dd2240dd3800 · 2024-12-03T14:53:32.000-08:00
More docs improvements
diff --git a/docs/concepts/authentication.md b/docs/concepts/authentication.md
@@ -4,9 +4,9 @@ title: Authentication
 description: Authenticating with Defang.
 ---
 
-# Authenticating with Defang
+# Authentication
 
-To do pretty much anything with Defang, you'll need to authenticate with the platform. You can do this by running the following command:
+To do pretty much anything with Defang, you'll need to authenticate with the system. You can do this by running the following command:
 
 ```bash
 defang login
diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx
@@ -106,7 +106,7 @@ You can open the folder in your favorite editor and see the files that were gene
 * The `Dockerfile` is used to build the container image for your service.
 * The `compose.yaml` file is used to define the services you want to deploy.
 
-## Deploy to the playground
+## Deploy to the Playground
 
 Go back to your shell and type the following:
 
@@ -122,7 +122,7 @@ Please visit http://127.0.0.1:49154 and log in. (Right click the URL or press EN
 ```
 
 :::info
-To learn more about how authentication works in Defang, check out the [Authenticating With Defang](/docs/concepts/authentication) page.
+To learn more about how authentication works in Defang, check out our [Authentication](/docs/concepts/authentication) page.
 :::
 
 When you do this, you should see something similar to the output below:
diff --git a/docs/intro/what-is-defang.mdx b/docs/intro/what-is-defang.mdx
@@ -8,10 +8,11 @@ description: What is Defang?
 
 <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>
 
-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.
+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.
 
-- 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.
-- Defang can automatically build and deploy your project with a single command.
-    - 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.
-    - 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.
-- You can also use Defang to easily [publish updates](/docs/concepts/deployments.md#deploying-updates) to your deployed application with zero downtime.
+- Develop: The [Defang CLI](/docs/getting-started#install-the-defang-cli.md) includes an AI-driven agent that translates natural language prompts to [generate](/docs/concepts/generate) an outline for your project that you can then refine.
+- Deploy: Defang can automatically build and deploy your project with a single command.
+    - If you’re new to Defang, you can try deploying to the [Defang Playground](/docs/concepts/defang-playground.md), a testing environment for learning how to use Defang.
+    - Once you’re ready, you can [deploy](docs/category/tutorials) a project 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.
+    - You can also use Defang to easily [publish updates](/docs/concepts/deployments.md#deploying-updates) to your deployed application with zero downtime.
+- Debug: 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.
diff --git a/docs/tutorials/deploy-container-using-the-cli.mdx b/docs/tutorials/deploy-container-using-the-cli.mdx
@@ -1,9 +1,9 @@
 ---
-title: Deploy existing container
+title: Deploy Existing Containers
 sidebar_position: 200
 ---
 
-# Deploy an Existing Container Using the CLI
+# Deploy Existing Containers
 
 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.
 
diff --git a/docs/tutorials/deploy-to-aws.mdx b/docs/tutorials/deploy-to-aws.mdx
@@ -4,7 +4,7 @@ description: Defang allows you deploy to your own Amazon Web Services (AWS) acco
 sidebar_position: 11
 ---
 
-# Deploying to Amazon Web Services (AWS) With Defang
+# Deploy to Amazon Web Services (AWS) 
 
 This tutorial will show you how to deploy your services to your own AWS account using Defang.
 
diff --git a/docs/tutorials/deploy-to-digitalocean.mdx b/docs/tutorials/deploy-to-digitalocean.mdx
@@ -4,7 +4,7 @@ description: Defang allows you deploy to your own DigitalOcean account.
 sidebar_position: 11
 ---
 
-# Deploying to DigitalOcean With Defang
+# Deploy to DigitalOcean
 
 This tutorial will show you how to deploy your services to your own DigitalOcean account using Defang.
 
diff --git a/docs/tutorials/deploy-to-gcp.mdx b/docs/tutorials/deploy-to-gcp.mdx
@@ -4,7 +4,7 @@ description: Defang allows you deploy to your own Google Cloud Platform (GCP) ac
 sidebar_position: 11
 ---
 
-# Deploying to Google Cloud Platform (GCP) With Defang
+# Deploy to Google Cloud Platform (GCP)
 
 This tutorial is coming soon.
 
diff --git a/docs/tutorials/deploy-to-playground.mdx b/docs/tutorials/deploy-to-playground.mdx
@@ -1,12 +1,12 @@
 ---
 title: Deploy to Playground
-description: Deploy to the Free Defang Playground
+description: Deploy to the free Defang Playground.
 sidebar_position: 15
 ---
 
-# Deploy to the playground
+# Deploy to Playground
 
-This tutorial will show you how to deploy your project to the Defang Playground.
+This tutorial will show you how to deploy your project to the free Defang Playground.
 
 ## Pre-requisites
 * [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
diff --git a/docs/tutorials/deploy-to-your-cloud.mdx b/docs/tutorials/deploy-to-your-cloud.mdx
@@ -1,22 +1,24 @@
 ---
-title: Deploy to Your Cloud
+title: Deploy to Your Own Cloud
 description: Defang allows you deploy to your own cloud account.
 sidebar_position: 10
 ---
 
-# Deploying to Your Cloud With Defang
+# Deploy to Your Own Cloud 
 
 This tutorial will show you how to deploy your services to your own cloud account using Defang.
 
 :::tip
-Defang makes it easier to deploy to any cloud—in your *own* cloud accounts. We refer to this as bring-your-own-cloud (BYOC).
-If you aren't ready to deploy to your own cloud account, you can use the Defang Playground to get a feel for how Defang works for free.
+Defang makes it easier to deploy to any cloud—in your *own* cloud accounts. We refer to this as [bring-your-own-cloud (BYOC)](/docs/concepts/defang-byoc).
+If you aren't ready to deploy to your own cloud account, you can use the [Defang Playground](/docs/concepts/defang-playground) to get a feel for how Defang works for free.
 :::
 
-## Choose your cloud
+## Choose your cloud 
 
-The first step is to choose which cloud provider you want to deploy to. Defang supports the following cloud providers:
+A good starting point is to choose which cloud provider you want to deploy to. Defang supports the following cloud providers:
 
 * [AWS](/docs/tutorials/deploy-to-aws)
 * [DigitalOcean](/docs/tutorials/deploy-to-digitalocean)
 * [GCP](/docs/tutorials/deploy-to-gcp)
+
+The above will link to a tutorial page for that cloud. If you run into any problems, please note that we have an [FAQ section](/docs/category/faq) for your convenience.
diff --git a/docs/tutorials/deploy-using-pulumi.mdx b/docs/tutorials/deploy-using-pulumi.mdx
@@ -1,5 +1,5 @@
 ---
-title: Deploy using Pulumi
+title: Deploy Using Pulumi
 sidebar_position: 400
 ---
 
diff --git a/docs/tutorials/deploy-with-gpu.mdx b/docs/tutorials/deploy-with-gpu.mdx
@@ -1,9 +1,9 @@
 ---
-title: Deploy a GPU-powered application
+title: Deploy a GPU-Powered Application
 sidebar_position: 500
 ---
 
-# Deploy a GPU-Powered Application With Defang
+# Deploy a GPU-Powered Application
 
 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.
 
diff --git a/docs/tutorials/generate-new-code-using-ai.mdx b/docs/tutorials/generate-new-code-using-ai.mdx
@@ -1,19 +1,22 @@
 ---
-title: Deploy an outline using AI
+title: Generate Project Outlines With AI
 sidebar_position: 50
 ---
 
-# Deploy an Outline of a Project Using AI
+# Generate Project Outlines With AI
+
+This tutorial will show you how to use Defang's AI agent to [generate](/docs/concepts/generate) a project outline, and then deploy that project to the cloud using Defang. 
 
-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 outline with all the files required to make it work.
 <iframe width="560" height="315" src="https://www.youtube.com/embed/afglsBYieuc?si=GCvHhBu3H9ktMDHA" 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>
 
+## Step 1 - Use the `defang generate` command in the CLI 
+
+Here you can describe what you would like the service to do and the [CLI](/docs/getting-started#install-the-defang-cli) will then [generate](/docs/concepts/generate) a project outline with all the files required to make it deployable with Defang.
 
-In this tutorial we'll use the following prompt:
+In this tutorial, we'll use the following prompt to describe our service:
 
-A basic service with 2 REST endpoints. The default endpoint will be for health check and should return a JSON object like this: `{ "status": "OK" }`. The /echo endpoint will echo back all request parameters in the response.
+"A basic service with 2 REST endpoints. The default endpoint will be for health check and should return a JSON object like this: `{ "status": "OK" }`. The /echo endpoint will echo back all request parameters in the response."
 
-## Step 1 - Use the CLI generate command
 ```text
 defang generate
 
@@ -32,7 +35,7 @@ A basic service with 2 REST endpoints. The default endpoint will be for health c
 project1
 ```
 
-This will generate the different files required to start your project based on your prompt and the language selected.
+This will [generate](/docs/concepts/generate) the different files required to start your project based on your prompt and the language selected.
 
 ## Step 2 - Review the Code
 
diff --git a/docs/tutorials/monitoring-your-services.md b/docs/tutorials/monitoring-your-services.md
@@ -4,8 +4,9 @@ title: Monitoring Your Services
 description: How to monitoring services deployed with Defang
 ---
 
-# How To Monitor Your Services With Defang
+# Monitoring Your Services
 
+Monitoring your services with Defang.
 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:
diff --git a/docs/tutorials/updating-your-services.md b/docs/tutorials/updating-your-services.md
@@ -4,7 +4,7 @@ title: Updating Your Services
 description: How to update services deployed with Defang
 ---
 
-# How To Update Your Services With Defang
+# Updating Your Services
 
 To update your app (for example, updating the base image of your container, or making changes to your code) you can run the `defang compose up` command and it will build and deploy a new version with zero downtime. Your current version of the service will keep running and handling traffic while the new version is being built and deployed. Only after the new version passes the health checks and accepts traffic will the older version be stopped.
 
diff --git a/docs/tutorials/use-your-own-domain-name.mdx b/docs/tutorials/use-your-own-domain-name.mdx
@@ -1,5 +1,5 @@
 ---
-title: How to use your own domain
+title: How to Use Your Own Domain
 sidebar_position: 600
 ---
 
diff --git a/docs/tutorials/using-codespaces-gitpod.md b/docs/tutorials/using-codespaces-gitpod.md
@@ -3,7 +3,7 @@ title: Using Codespaces and Gitpod
 sidebar_position: 700
 ---
 
-# Defang With Codespaces and GitPod
+# Using Codespaces and GitPod
 
 <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>
 
