Skip to content

Commit 54dd802

Browse files
Reorganize Docs (#311)
* setup nix flake * reorganizing docs to avoid deeply nested sidebar This commit moves primary sections into the top nav and uses unique sidebars for each section. This commit also adds a non-generated index page to each section where we can highlight specific pages that are likely to be most interesting. A few page urls were changed, redirects have been added. * cp cli-index.md after autogeneration
1 parent 173342a commit 54dd802

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+411
-149
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,5 @@ defang
2323
samples
2424
/docs/samples.md
2525
/static/samples-v2.json
26+
.envrc
27+
.direnv

blog/2024-02-12-announcing-defang-public-beta.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Ever since we shipped our Private Beta in the summer of 2023, we have been worki
1111

1212
And so, today with our Public Beta, we are addressing this request. With today’s release of [Defang BYOC](/docs/concepts/defang-byoc) (Bring-your-own-Cloud), you can now enjoy all the benefits of Defang **and** deploy applications to your own AWS account! Our Private Beta experience is still available as [Defang Playground](/docs/concepts/defang-playground) for you to quickly and easily prototype applications and deploy them to our hosted environment.
1313

14-
You can learn more about Defang [here](/docs/intro). Also check out our [tutorials](/docs/category/tutorials), [samples](https://defang.io/samples), and [FAQ](/docs/category/faq) to know more.
14+
You can learn more about Defang [here](/docs/intro). Also check out our [tutorials](/docs/tutorials), [samples](https://defang.io/samples), and [FAQ](/docs/category/faq) to know more.
1515

1616
{/* truncate */}
1717

1818
**Try the Public Beta!**
1919

20-
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](/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).
20+
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](/docs/intro/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).
2121

2222
**Stay Tuned for More**
2323

blog/2024-03-28-slackbot-sample.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Hey folks! Today, I'm going to share one of our code samples that will show you
1111

1212
Before we dive into the details, let's make sure you have everything you need to get started:
1313

14-
1. **Install Defang CLI:** Simplify your deployment process by installing the Defang CLI tool. Follow the instructions [here](/docs/getting-started#install-the-defang-cli) to get it up and running quickly.
14+
1. **Install Defang CLI:** Simplify your deployment process by installing the Defang CLI tool. Follow the instructions [here](/docs/intro/getting-started#install-the-defang-cli) to get it up and running quickly.
1515

1616
2. **Slack API Token:** Create a Slack App at https://api.slack.com/apps, granting it the necessary permissions, including the bot `chat:write` scope.
1717
![screenshot of the slack admin UI showing the bot scopes](/img/slackbot-sample/scopes.png)

blog/2025-02-18-model-context-protocol.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Here we can see what changes if we deploy to the cloud:
132132
1. Service 1 and Service 2 are now deployed to the cloud, not on the local machine anymore.
133133
2. The only part on the local machine is the browser.
134134

135-
Using the same `compose.yaml` file as shown earlier, we can deploy the containers to the cloud with the [Defang CLI](/docs/getting-started). Once we’ve authenticated and logged in, we can [choose a cloud provider (i.e. AWS, GCP, or DigitalOcean)](/docs/tutorials/deploy-to-your-cloud) and use our own cloud account for deployment. Then, we can set a configuration variable for the Anthropic API key:
135+
Using the same `compose.yaml` file as shown earlier, we can deploy the containers to the cloud with the [Defang CLI](/docs/intro/getting-started). Once we’ve authenticated and logged in, we can [choose a cloud provider (i.e. AWS, GCP, or DigitalOcean)](/docs/tutorials/deploy-to-your-cloud) and use our own cloud account for deployment. Then, we can set a configuration variable for the Anthropic API key:
136136

137137
```bash
138138
defang config set ANTHROPIC_API=<your-api-key-value>

blog/2025-04-10-easiest-way-to-deploy-django.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Once deployed, your app is accessible via a public URL provided by Defang, which
9393

9494
### Deploying to Your Own Cloud
9595

96-
To deploy directly into your AWS account (or other [supported providers](/docs/category/providers)):
96+
To deploy directly into your AWS account (or other [supported providers](/docs/providers)):
9797

9898
1. Set your cloud provider:
9999
> In my case, I use an AWS Profile, but you should be able to use [any methods supported by the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)

cli-index.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
sidebar_position: 1
3+
title: Defang CLI Reference
4+
description: Learn about the Defang CLI
5+
---
6+
7+
import DocCardList from "@docusaurus/theme-classic/lib/theme/DocCardList";
8+
9+
The Defang CLI takes your app from Docker Compose to a secure and scalable deployment on your favorite cloud in minutes.
10+
11+
# Featured Commands
12+
13+
<DocCardList
14+
items={[
15+
{
16+
type: "link",
17+
href: "/docs/cli/compose-up",
18+
label: "defang compose up",
19+
description: "Learn how to deploy your application",
20+
},
21+
{
22+
type: "link",
23+
href: "/docs/cli/config-set",
24+
label: "defang config set",
25+
description: "Learn how to set configuration values for your deployment",
26+
},
27+
{
28+
type: "link",
29+
href: "/docs/cli/compose-logs",
30+
label: "defang compose logs",
31+
description: "Learn how to view your application logs",
32+
},
33+
{
34+
type: "link",
35+
href: "/docs/cli/compose-services",
36+
label: "defang compose services",
37+
description: "Learn how to view your deployed services",
38+
},
39+
]}
40+
/>
41+
42+
For a complete list of commands, check out the sidebar.

docs/cli/_category_.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
{
22
"label": "CLI",
3-
"position": 500,
43
"link": {
4+
"slug": "cli",
55
"type": "generated-index",
66
"description": "Documentation of the Defang CLI (command line interface) commands."
77
}
88
}
9-

docs/concepts/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"label": "Concepts",
3-
"position": 500,
43
"link": {
4+
"slug": "concepts",
55
"type": "generated-index",
66
"description": "Some concepts to help explain how the Defang system is organized and tooling that will help you manage your applications."
77
}

docs/concepts/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Authenticating with Defang.
55

66
# Authentication
77

8-
To do pretty much anything with Defang, you'll need to authenticate with the system. You can do this by running the following command in the [CLI](/docs/getting-started):
8+
To do pretty much anything with Defang, you'll need to authenticate with the system. You can do this by running the following command in the [CLI](/docs/intro/getting-started):
99

1010
```bash
1111
defang login

docs/concepts/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ If you have created a service before a secret you can connect it by running the
9595
9696
Here are the different ways sensitive config values are stored depending on the provider you are using:
9797
98-
* [AWS](../providers/aws/aws.md#secrets)
99-
* [DigitalOcean](../providers/digitalocean#secrets)
100-
* [GCP](../providers/gcp#secrets)
98+
* [AWS](/docs/providers/aws#secrets)
99+
* [DigitalOcean](/docs/providers/digitalocean#secrets)
100+
* [GCP](/docs/providers/gcp#secrets)
101101
102102
:::info
103103
Please note that while Defang supports setting sensitive config, it does not support the [`secrets`](https://docs.docker.com/reference/compose-file/secrets/) top-level element as seen in the Compose specification. Please see our [Compose](/docs/concepts/compose) page for more details.

0 commit comments

Comments
 (0)