Merge pull request #145 from DefangLabs/linda-dashboard

commit111 · web-flow · commit 4ab2dc0eb843 · 2024-12-10T09:38:56.000-08:00
More grammar fixes
diff --git a/blog/2023-06-29-Announcing-the-Private-Beta-for-the-DOP.md b/blog/2023-06-29-Announcing-the-Private-Beta-for-the-DOP.md
@@ -12,7 +12,7 @@ We realize that improving on this state of affairs is a long journey. Today, we
 
 **Try the Private Beta!**
 
-To try the Private Beta, please go to [portal.defang.dev](https://portal.defang.dev) and register. We would love to have you kick the tires and give us your feedback! You can also check out our [documentation](https://docs.defang.io/docs/intro), [samples](https://docs.defang.io/docs/intro), and our [Github repository](https://github.com/DefangLabs).
+To try the Private Beta, please go to [portal.defang.dev](https://portal.defang.dev) and register. We would love to have you kick the tires and give us your feedback! You can also check out our [documentation](https://docs.defang.io/docs/intro), [samples](https://docs.defang.io/docs/intro), and our [GitHub repository](https://github.com/DefangLabs).
 
 **Stay Tuned for More**
 
diff --git a/blog/2024-02-12-announcing-defang-public-beta.md b/blog/2024-02-12-announcing-defang-public-beta.md
@@ -16,7 +16,7 @@ You can learn more about Defang [here](https://docs.defang.io/docs/intro). Also
 
 **Try the Public Beta!**
 
-To try the Public Beta, please go to [defang.io](http://defang.io) and click on [Download](https://github.com/DefangLabs/defang/releases/latest) to download the CLI and [get started](https://docs.defang.io/docs/getting-started). We would love to have you kick the tires and give us your feedback! Once you sign up you’ll receive an invitation to our Slack support channel in email. You are also welcome to file [Github issues here](https://github.com/DefangLabs/defang/issues).
+To try the Public Beta, please go to [defang.io](http://defang.io) and click on [Download](https://github.com/DefangLabs/defang/releases/latest) to download the CLI and [get started](https://docs.defang.io/docs/getting-started). We would love to have you kick the tires and give us your feedback! Once you sign up you’ll receive an invitation to our Slack support channel in email. You are also welcome to file [GitHub issues here](https://github.com/DefangLabs/defang/issues).
 
 **Stay Tuned for More**
 
diff --git a/blog/2024-03-20-dev-environments.mdx b/blog/2024-03-20-dev-environments.mdx
@@ -21,6 +21,6 @@ If you want to get started with Codespaces, you can just fork [this repo](https:
 
 [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) are a cool way to provision and configure development environments and share that configuration with other people you are working with. It's a spec that is supported by [VS Code](https://code.visualstudio.com/docs/devcontainers/containers), [Visual Studio](https://devblogs.microsoft.com/cppblog/dev-containers-for-c-in-visual-studio/), the JetBrains IDEs like [IntelliJ](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html) and [PyCharm](https://www.jetbrains.com/help/pycharm/connect-to-devcontainer.html), [DevPod](https://devpod.sh/docs/developing-in-workspaces/devcontainer-json) and others.
 
-## GitPod
+## Gitpod
 
-GitPod is another Cloud IDE, a bit like GitHub Codespaces. If prefer GitPod, you can try Defang in a GitPod environment by using [this repo](https://github.com/DefangLabs/gitpod-workspace/tree/main).
+Gitpod is another Cloud IDE, a bit like GitHub Codespaces. If prefer Gitpod, you can try Defang in a Gitpod environment by using [this repo](https://github.com/DefangLabs/gitpod-workspace/tree/main).
diff --git a/docs/concepts/deployments.md b/docs/concepts/deployments.md
@@ -6,7 +6,7 @@ sidebar_position: 500
 
 # Deployment
 
-When you deploy using Defang, whether it's with `defang compose up` with a [compose file](./compose.md) or using a [Pulumi program](./pulumi.md), Defang will build your services in the cloud and manage the deployment process for you. If you provide a Dockerfile and build context, Defang will upload the files found within the build context to the cloud (either yours in [Defang BYOC](./defang-byoc.md) or ours in [Defang Playground](./defang-playground.md)), build the image, and store it in the cloud provider's container registry. 
+When you deploy using Defang, whether it's with `defang compose up` with a [Compose file](./compose.md) or using a [Pulumi program](./pulumi.md), Defang will build your services in the cloud and manage the deployment process for you. If you provide a Dockerfile and build context, Defang will upload the files found within the build context to the cloud (either yours in [Defang BYOC](./defang-byoc.md) or ours in [Defang Playground](./defang-playground.md)), build the image, and store it in the cloud provider's container registry. 
 
 ## Deploying Updates
 
diff --git a/docs/concepts/managed-storage/managed-postgres.md b/docs/concepts/managed-storage/managed-postgres.md
@@ -85,7 +85,7 @@ The AWS Console can be used to restore a snapshop into a new instance of postgre
 <!-- 
 ### Major Version Updating of Engine
 
-To update the database engine you can update the image to a later version in your compose file and apply it via ```defang compose up --provider=aws```. In the example below, we change from Postgres 15 to 16.
+To update the database engine you can update the image to a later version in your Compose file and apply it via ```defang compose up --provider=aws```. In the example below, we change from Postgres 15 to 16.
 
 Please note the upgrading will occur immediately and may result in the database being unavailable for some time.
 
diff --git a/docs/concepts/projects.md b/docs/concepts/projects.md
@@ -6,11 +6,11 @@ sidebar_position: 200
 
 # Projects
 
-A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yaml` file.
+A _project_ refers to a cohesive collection of services which are defined and managed using a [`compose.yaml` file](./compose.md).
 
 ## Project Names
 
-The _project name_ can be defined in the compose file with [the `name` property](https://docs.docker.com/compose/compose-file/04-version-and-name/#name-top-level-element), otherwise the base name of the project directory will be used.
+The _project name_ can be defined in the Compose file with the [`name` property](https://docs.docker.com/compose/compose-file/04-version-and-name/#name-top-level-element), otherwise the base name of the project directory will be used.
 
 The project name may then be used when performing project-wide operations such as listing services, tailing logs, or deprovisioning. For example:
 ```
diff --git a/docs/concepts/services.md b/docs/concepts/services.md
@@ -6,17 +6,17 @@ sidebar_position: 200
 
 # Services
 
-Defang allows you deploy services defined as containers. You can define your services using a [compose file](./compose.md) or a [Pulumi program](./pulumi.md). Services can be exposed to the internet or kept private, and can communicate between themselves using the following conventions for hostnames:
+Defang allows you deploy services defined as containers. You can define your services using a [Compose file](./compose.md) or a [Pulumi program](./pulumi.md). Services can be exposed to the internet or kept private, and can communicate between themselves using the following conventions for hostnames:
 
 `<username>-<service-name>`
 
 You can learn more about accounts and usernames in the [accounts page](./accounts.md).
 
 :::tip Service Names
-Service names are defined in your compose file or your Pulumi program.
+Service names are defined in your Compose file or your Pulumi program.
 :::
 
-You can learn more about about how to define [services with compose files here](./compose.md) and [services with Pulumi here](./pulumi.md). You can learn more about how services are deployed in the [deployment page](./deployments.md).
+You can learn more about about how to define [services with Compose files here](./compose.md) and [services with Pulumi here](./pulumi.md). You can learn more about how services are deployed in the [deployment page](./deployments.md).
 
 :::info
 While this is the current state of the Defang model, we plan to add support for other types of services in the future, including serverless functions.
diff --git a/docs/intro/intro.mdx b/docs/intro/intro.mdx
@@ -27,7 +27,7 @@ import DocCardList from "@docusaurus/theme-classic/lib/theme/DocCardList";
                 type: "link",
                 href: "/docs/category/cli",
                 label: "CLI Reference",
-                description: "Use the defang CLI to deploy your app",
+                description: "Use the Defang CLI to deploy your app",
             },
             {
                 type: "link",
diff --git a/docs/tutorials/deploy-to-aws.mdx b/docs/tutorials/deploy-to-aws.mdx
@@ -44,7 +44,7 @@ $ defang compose up --provider=aws
 
 ## Step 4 - Inspect your deployment
 
-Defang will provision resources in your AWS account and deploy your services. You can inspect the resources created in your AWS dashboard.
+Defang will provision resources in your AWS account and deploy your services. You can inspect the resources created in your AWS Dashboard.
 
 ***
 
diff --git a/docs/tutorials/deploy-to-digitalocean.mdx b/docs/tutorials/deploy-to-digitalocean.mdx
@@ -41,7 +41,7 @@ $ defang compose up --provider=do
 
 ## Step 4 - Inspect your deployment
 
-Defang will provision resources in your DigitalOcean account and deploy your services. You can inspect the resources created in your DigitalOcean dashboard.
+Defang will provision resources in your DigitalOcean account and deploy your services. You can inspect the resources created in your DigitalOcean Dashboard.
 
 ***
 
diff --git a/docs/tutorials/deploy-with-gpu.mdx b/docs/tutorials/deploy-with-gpu.mdx
@@ -5,7 +5,7 @@ sidebar_position: 500
 
 # Deploy a GPU-Powered Application to AWS
 
-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.
+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 the [Mistral & vLLM](https://github.com/DefangLabs/samples/tree/main/samples/vllm) sample.
 
 :::info
 Note that GPU deployments are not permitted on the Defang Playground. You must [upgrade to a paid account](https://defang.io/pricing/) and [deploy to your own cloud account](https://docs.defang.io/docs/tutorials/deploy-to-your-cloud).
@@ -31,11 +31,11 @@ This process can take a few days for AWS to approve.
 
 ### HuggingFace Token
 
-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.
+This sample requires a HuggingFace 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.
 
 ## Step 1 - Clone the sample project
 
-You'll need to clone [this sample](https://github.com/DefangLabs/samples/tree/main/samples/vllm) to go through this tutorial.
+You'll need to clone the [Mistral & vLLM](https://github.com/DefangLabs/samples/tree/main/samples/vllm) sample to go through this tutorial.
 
 ## Step 2 - Check your [Defang BYOC](../concepts/defang-byoc.md) settings
 
@@ -99,7 +99,7 @@ services:
 
 **Let's break it down.**
 
-We start with the latest vLLM docker image provided by [Mistral AI](https://docs.mistral.ai/self-deployment/vllm/).
+We start with the latest vLLM Docker image provided by [Mistral AI](https://docs.mistral.ai/self-deployment/vllm/).
 
 ```yaml
 mistral:
diff --git a/docs/tutorials/monitoring-your-services.md b/docs/tutorials/monitoring-your-services.md
@@ -1,22 +1,24 @@
 ---
 sidebar_position: 400
 title: Monitoring Your Services
-description: How to monitoring services deployed with Defang
+description: How to monitor services deployed with Defang
 ---
 
 # Monitoring Your Services
 
+This page will show you how to monitor your service status and logs in Defang.
+
 ## Status
 
 When deploying to Playground, you can monitor your service status from the [Defang Portal](https://portal.defang.dev).
 
-When deploying to your own cloud, the primary way to monitor your services is through your cloud provider's dashboard. Defang does, however, provide some tools for monitoring your service logs.
+When deploying to your own cloud, the primary way to monitor your services is through your cloud provider's dashboard. However, Defang does provide some tools for monitoring your service logs.
 
 ## Logs
 
 When deploying to Playground, your service's logs may be viewed in the [Defang Portal](https://portal.defang.dev).
 
-By default, all the output (stdout and stderr) from your app is logged. You can view these logs in real-time or for a time in the past. You can view logs for all your services, one service, or even one specific deployment of a service.
+By default when deploying, including to your own cloud, all output (stdout and stderr) from your app is logged and accessible via the [Defang CLI](/docs/getting-started#install-the-defang-cli). You can view these logs in real-time or for a time in the past. You can view logs for all your services, one service, or even one specific deployment of a service. 
 
 ### Tailing Live Logs For All Services
 
diff --git a/docs/tutorials/updating-your-services.md b/docs/tutorials/updating-your-services.md
@@ -10,7 +10,7 @@ To update your app (for example, updating the base image of your container, or m
 
 ## Deploying New Services or Removing Existing Services
 
-If you are using [compose files](../concepts/compose.md) to define your services, you can add/remove services, make changes to code, etc. When you run `defang compose up`, the update will be diffed against the current state and any necessary changes will be applied to make the current state match the desired state.
+If you are using [Compose files](../concepts/compose.md) to define your services, you can add/remove services, make changes to code, etc. When you run `defang compose up`, the update will be diffed against the current state and any necessary changes will be applied to make the current state match the desired state.
 
 ## Deployment Modes
 
diff --git a/docs/tutorials/use-your-own-domain-name.mdx b/docs/tutorials/use-your-own-domain-name.mdx
@@ -5,6 +5,8 @@ sidebar_position: 600
 
 # How to Use Your Own Domain With AWS
 
+This tutorial will show you how to set up and use your own domain when deploying to AWS using Defang.
+
 <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>
 
 ## Prerequisites
@@ -35,7 +37,7 @@ You'll need to create NS records in your domain registrar that point to the AWS
 
 
 ## Step 3 - Set up Your Compose File
-In your compose file, specify the domain name you want to use, for example
+In your Compose file, specify the domain name you want to use, for example:
 
 ```yaml
 services:
@@ -56,7 +58,7 @@ Run the following command to deploy your service:
 defang compose up
 ```
 
-This will deploy your service and set up the necessary DNS records in Route 53 as seen in the screenshot below as well as provision SSL certificates. You can now access your service at the domain you specified in your compose file.
+This will deploy your service and set up the necessary DNS records in Route 53 as seen in the screenshot below as well as provision SSL certificates. You can now access your service at the domain you specified in your Compose file.
 
 <img src="/img/domains-tutorial/route53-records.png" alt="Route 53 DNS Records Screenshot" />
 
diff --git a/docs/tutorials/using-codespaces-gitpod.md b/docs/tutorials/using-codespaces-gitpod.md
@@ -3,16 +3,16 @@ title: Using Codespaces and Gitpod
 sidebar_position: 700
 ---
 
-# Using 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>
+This tutorial will guide you to set up Defang in both GitHub Codespaces and Gitpod.
 
-This tutorial will guide you to set up Defang in both 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>
 
-## Getting Started with Github Codespaces and Defang
+## Using Codespaces With Defang
 
 ### Step 1 - Clone the Defang Codespace Project
-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.
+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.
 
 
 ### Step 2 - Create a Codespace
@@ -40,23 +40,23 @@ Although it may initially refuse to connect on your localhost, going back will s
 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.
 
 
-## Getting Started with GitPod Workspace with Defang
+## Using Gitpod With Defang
 
-### Step 1 - Clone the Defang GitPod Workspace Project
+### Step 1 - Clone the Defang Gitpod Workspace Project
 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.
 
 
-### Step 2 - Initialize GitPod Workspace
+### Step 2 - Initialize a Gitpod Workspace
 Navigate `https://gitpod.io/#<your-repo-url>` to create your new workspace.
-In the repository, we have a yaml file indicating that we are using a pre-built dockerfile which installs Defang CLI for you.
+In the repository, we have a YAML file indicating that we are using a pre-built Dockerfile which installs Defang CLI for you.
 
 
-### Step 3 - Lauch VS Code from GitPod
-Open VS Code from GitPod, you will likely need to have the GitPod VS Code extension installed.
+### Step 3 - Lauch VS Code from Gitpod
+Open VS Code from Gitpod, you will likely need to have the Gitpod VS Code extension installed.
 
 ![Open in vs code desktop button screenshot](/img/codespace-tutorial/gitpod-desktop.png)
 
-![Screenshot of GitPod extension](/img/codespace-tutorial/gitpod-ext.png)
+![Screenshot of Gitpod extension](/img/codespace-tutorial/gitpod-ext.png)
 
 
 ### Step 4 - Run Defang Login

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ import DocCardList from "@docusaurus/theme-classic/lib/theme/DocCardList";`
`27`	`27`	`type: "link",`
`28`	`28`	`href: "/docs/category/cli",`
`29`	`29`	`label: "CLI Reference",`
`30`		`- description: "Use the defang CLI to deploy your app",`
	`30`	`+ description: "Use the Defang CLI to deploy your app",`
`31`	`31`	`},`
`32`	`32`	`{`
`33`	`33`	`type: "link",`