Merge branch 'main' of https://github.com/DefangLabs/defang-docs into do-docs

Author: kt5356

.github/workflows/deploy.yml

@@ -11,6 +11,7 @@ on:
 
 jobs:
   deploy:
+    environment: github-pages
     permissions:
       # This is required to allow the GH actions bot to commit to the `gh-pages` branch
       contents: write
@@ -82,6 +83,12 @@ jobs:
           user_email: 41898282+github-actions[bot]@users.noreply.github.com
           cname: docs.defang.io
 
+      
+      # Notify docs chatbot of new docs with curl command
+      - name: Notify docs chatbot of new docs
+        run: |
+          curl -X POST https://ask.defang.io/trigger-rebuild?token=${{ secrets.CHATBOT_TOKEN }}
+
 
       - name: Notify Slack of Action Failures
         uses: ravsamhq/[email protected]

README.md

@@ -5,25 +5,31 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
 ### Installation
 
 ```
-$ npm
+$ npm install
 ```
-
-### Local Development
+Make sure that you've cloned the `defanglabs/defang` repo and `defanglabs/samples` repo in sibling directories.
 
 ```
-$ npm serve
+$ git clone https://github.com/DefangLabs/defang.git ../defang 
+$ git clone https://github.com/DefangLabs/samples.git ../samples
 ```
 
-This command starts a local development server and opens up a browser window. 
-
 ### Build
 
 ```
-$ npm build
+$ npm run build
 ```
 
 This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
+### Local Development
+
+```
+$ npm run start
+```
+
+This command starts a local development server and opens up a browser window. 
+
 ### Deployment
 
 Using SSH:

blog/2024-05-01-may-product-updates.md

@@ -1,10 +1,12 @@
 ---
 slug: may-2024-product-update
-title: April 2024 Product Update
-tags: [Cloud, NoDevOps, BYOC, AWS ECS, defang compose up]
+title: April 2024 Defang Compose Update
+tags: [Cloud, NoDevOps, BYOC, AWS ECS, defang compose up, Defang Compose Update]
 author: Defang Team
 ---
 
+![Defang Compose Update](/img/defang-compose-update.webp)
+
 Hey folks! There is a lot going on at Defang and we're excited to share our latest product updates with you. Over the last month, we've been working hard to improve the Defang system and make it even easier for you to deploy your applications. Here's a quick overview of what we've been up to:
 
 ## npx defang

blog/2024-06-01-june-product-updates.md

@@ -1,10 +1,12 @@
 ---
 slug: june-2024-product-update
-title: May 2024 Product Update
-tags: [Cloud, NoDevOps, BYOC, Playground, Load Testing, ACME, Managed Redis, Kaniko, Postgres, ECS]
+title: May 2024 Defang Compose Update
+tags: [Cloud, NoDevOps, BYOC, Playground, Load Testing, ACME, Managed Redis, Kaniko, Postgres, ECS, Defang Compose Update]
 author: Defang Team
 ---
 
+![Defang Compose Update](/img/defang-compose-update.webp)
+
 Hey folks! We’re back with another exciting update about Defang. Our team has been working hard to bring you new features and improvements so you can get deploying faster. Here’s a rundown of what we’ve been up to this month:
 
 

blog/2024-07-01-july-product-updates.md

@@ -1,10 +1,12 @@
 ---
 slug: july-2024-product-update
-title: June 2024 Product Update 
-tags: [Cloud, NoDevOps, BYOC, Windows, Managed Redis, CLI]
+title: June 2024 Defang Compose Update
+tags: [Cloud, NoDevOps, BYOC, Windows, Managed Redis, CLI, Defang Compose Update]
 author: Defang Team
 ---
 
+![Defang Compose Update](/img/defang-compose-update.webp)
+
 Hey folks! We've got another batch of updates to share with you about what the Defang team has been working on over the past month. We're committed to improving your deployment experience, so let's take a look at what's new.
 
 ## Windows Experience Improvements

blog/2024-07-31-july-product-updates-2.md

@@ -1,7 +1,7 @@
 ---
 slug: 2024-07-31-product-update
-title: July 2024 Product Update 
-tags: [Cloud, NoDevOps, BYOC, CLI, AI, Debugging]
+title: July 2024 Defang Compose Update
+tags: [Cloud, NoDevOps, BYOC, CLI, AI, Debugging, Defang Compose Update]
 author: Defang Team
 ---
 

blog/2024-08-30-august-product-updates.md

@@ -0,0 +1,71 @@
+---
+slug: 2024-08-31-product-update
+title: August 2024 Defang Compose Update
+tags:
+  [
+    Cloud,
+    NoDevOps,
+    BYOC,
+    Digital Ocean,
+    CLI,
+    AI,
+    Debugging,
+    Defang Compose Update,
+  ]
+author: Defang Team
+---
+import { Button } from '@mui/material';
+
+
+![Defang Compose Update](/img/defang-compose-update.webp)
+
+Wow - what a month of August it has been! We made some big strides of progress on our vision of providing a radically simpler way to Develop, Deploy, and Debug _portable_ cloud applications.
+
+## Ask Defang
+
+We've just rolled out an initial version of Ask Defang, our AI-driven documentation assistant that can help you navigate the Defang docs and get deploying faster. It's deployed with Defang and using a combination of embeddings run on a GPU-powered service, Defang managed Redis, and OpenAI APIs.
+
+Check it out [here](/docs/ask) or head to [ask.defang.io](https://ask.defang.io) to get started!
+
+## Enhanced Platform Symmetry
+
+We've been hard at work improving the symmetry between our Playground and BYOC environments as well as `docker compose up` vs `defang compose up` to provide a more seamless experience. You can now use multiple compose files and in BYOC the CLI will subscribe to events to monitor service health during deployments.
+
+## AI Features and Debugging Improvements
+
+We've been working on several AI-driven enhancements to make your development process even more efficient. We've addressed key issues, such as file generation failures due to parsing errors and invalid compose files. Also, our Debug Assistant is now more robust, handling context size limits better than before.
+
+---
+
+![Workshop](/img/august-update/workshop.jpg)
+
+## August Events
+
+This month, we hosted an in-person [workshop](https://www.linkedin.com/feed/update/urn:li:activity:7233915052083310595/) to get more developers acquainted with Defang and simplify their cloud app journey. You can view the presentation [here](https://s.defang.io/cloudjam2024). We also held the first-ever DevTools Vancouver [meetup](https://www.linkedin.com/posts/defanglabs_devtoolsmeetup-activity-7234599713751060483-zQsg?utm_source=share&utm_medium=member_desktop), bringing together local DevTool founders, engineers, and enthusiasts.
+
+Looking ahead, we’re excited to collaborate with [MLH](https://mlh.io/), [Hack the North](https://hackthenorth.com/), [LangaraHacks](https://lhacks.langaracs.ca/), and more in September. If you'd like to attend any of these events, be sure to sign up!
+
+---
+
+<img src="/img/august-update/townhall.png" alt="TownHall" style={{ width: 300 }} />
+
+## Townhall
+
+Mark your calendars! If you’re eager to learn more about what’s coming next, join us for our Townhall on September 25th. We’ll be sharing our future roadmap, answering your questions, and gathering your feedback.
+
+<Button href="https://lu.ma/9d8irae8" variant="contained" size="large" target="_blank">
+Register here!
+</Button>
+
+---
+
+## Roadmap
+
+We're working on a number of new features to make Defang even better. Here are some of the most exciting ones:
+
+- **Managed Postgres**: We're working on getting Defang to provision managed Postgres services for you, so you can easily store and query data in your applications.
+- **Digital Ocean BYOC**: We're working on adding Digital Ocean BYOC to give you even more choice over where you deploy your applications.
+
+---
+
+We’re excited to keep enhancing Defang to make it the easiest way for you to Develop, Deploy, and Debug cloud applications. Stay tuned for more updates next month! 🚀

docs/ask.md

@@ -0,0 +1,19 @@
+---
+title: "Ask Defang"
+description: This is a chatbot that is trained on defang documentation and designed to answer questions
+sidebar_position: 900
+className: "no-title-page"
+---
+
+<iframe 
+    src="https://ask.defang.io" 
+    style={{ 
+        width: "100%", // Assuming the sidebar width is 250px
+        height: "calc(100vh - 60px)", // Assuming the header height is 60px
+        minHeight: "600px",
+        border: "none",
+        marginLeft: "0px",
+        marginRight: "0px",
+        display: "block" // Ensures proper centering
+    }}>
+</iframe>

docs/concepts/compose.md

@@ -12,7 +12,7 @@ You might be familiar with `docker-compose.yml` files, now known as the [Compose
 
 You can define your [services](./services.md) using a `compose.yaml` file in the root of your project, or use the [`defang generate` command](../tutorials/generate-new-code-using-ai.mdx) to generate one (along with other resources). This file is used to define your application's services and how they run. You can edit this file to add more services or change the configuration of existing services.
 
-When you run `defang up`, Defang will read your `compose.yaml` file and [deploy](./deployments.md) the services named in that file to the cloud.
+When you run `defang compose up`, Defang will read your `compose.yaml` file and [deploy](./deployments.md) the services named in that file to the cloud.
 
 ## Service Name Resolution
 
@@ -40,5 +40,5 @@ secrets:
 ```
 
 :::info Configuration & Secrets
-Read more about configuration in the [configuration page](./configuration.md) and about secrets in the [secrets page](./configuration.md).
-:::
+Read more about configuration in the [configuration page](./configuration.md).
+:::

docs/concepts/configuration.md

@@ -23,14 +23,25 @@ defang config set API_KEY
 
 You can use sensitive config by specifying them in the `environment` section of a service in a `compose.yaml` file without any value, or by specifying an environment key with a `null` value in your Pulumi code.
 
-```ts
+```yaml
 services:
   service1:
     image: image1:latest
     environment:
       - API_KEY
 ```
 
+You can also use this syntax:
+
+
+```yaml
+services:
+  service1:
+    image: image1:latest
+    environment:
+      API_KEY:
+```
+
 Use the `defang config` command of the Defang CLI to manage the values.
 
 ## Connecting Services
@@ -45,4 +56,4 @@ You can find a sample of how to set sensitive config values [here](https://githu
 
 Here are the different ways sensitive config values are stored depending on the provider you are using:
 
-    * [AWS](../providers/aws.md#secrets)
+    * [AWS](../providers/aws/aws.md#secrets)