Skip to content

Commit ad6aae1

Browse files
move installing page into "Getting Started"
1 parent b02b8aa commit ad6aae1

15 files changed

+66
-75
lines changed

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](https://docs.defang.io/docs/getting-started/installing) 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](https://docs.defang.io/docs/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)

docs/concepts/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ defang login
1515
This will prompt you to open a browser and log into your Defang account. For now, the only way to login is with GitHub, though we will offer other providers to authenticate in the future. Once you've logged in, you can close the browser and return to the terminal. You should see a message that you've successfully logged in.
1616

1717
:::warning
18-
Keep in mind that your Defang account is separate from your [cloud provider account](../concepts/defang-byoc.md). You will need to authenticate with your cloud provider account separately to deploy services to your own cloud account.
18+
Keep in mind that your Defang account is separate from your [cloud provider account](/docs/concepts/defang-byoc). You will need to authenticate with your cloud provider account separately to deploy services to your own cloud account.
1919
:::

docs/concepts/generate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 100
66

77
# Generate
88

9-
Defang includes an AI-driven agent that translates natural language prompts to an outline for your project that you can then refine. The AI agent is available through the [Defang CLI](../getting-started/installing.md).
9+
Defang includes an AI-driven agent that translates natural language prompts to an outline for your project that you can then refine. The AI agent is available through the [Defang CLI](../getting-started#install-the-defang-cli.md).
1010

1111
:::info
1212
The AI agent is currently in preview and only supports a limited set of prompts, varying in complexity. We plan to expand the capabilities of the AI agent in the future.

docs/getting-started/getting-started.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,61 @@ title: Getting Started
44
description: Get started with Defang.
55
---
66

7+
import Tabs from '@theme/Tabs';
8+
import TabItem from '@theme/TabItem';
9+
710
# Getting Started
811

12+
## Install the Defang CLI
13+
14+
Defang doesn't require installing anything in your cloud, but you will need to install the [open source](https://github.com/DefangLabs/defang) Defang command line interface (CLI) to interact with your Defang resources and account.
15+
16+
We offer a few different ways to install the Defang CLI. You can use a shell script, Homebrew, Winget, or you can download the binary directly.
17+
18+
19+
<Tabs>
20+
<TabItem value="bash" label="Shell">
21+
**Using a shell script**
22+
23+
You can install the Defang CLI using a shell script. Run the following command in your terminal:
24+
25+
```bash
26+
eval "$(curl -fsSL s.defang.io/install)"
27+
```
28+
29+
The script will try to download the appropriate binary for your operating system and architecture, add it to `~/.local/bin`, and add `~/.local/bin` to your `PATH` if it's not already there, with your permission. If you do not provide permission it will print an appropriate instruction for you to follow to add it manually. You can also customize the installation directory by setting the `INSTALL_DIR` environment variable before running the script.
30+
</TabItem>
31+
<TabItem value="homebrew" label="Homebrew" default>
32+
**Using Homebrew**
33+
34+
You can easily install the Defang CLI using [Homebrew](https://brew.sh/). Run the following command in your terminal:
35+
36+
```bash
37+
brew install DefangLabs/defang/defang
38+
```
39+
</TabItem>
40+
<TabItem value="winget" label="Winget">
41+
**Using Winget**
42+
43+
On Windows, you can install the Defang CLI using `winget`. Run the following command in your terminal:
44+
45+
```powershell
46+
winget install defang
47+
```
48+
</TabItem>
49+
<TabItem value="nix" label="Nix">
50+
**Using Nix**
951

10-
## Install the CLI
52+
```bash
53+
nix profile install github:DefangLabs/defang#defang-bin --refresh
54+
```
55+
</TabItem>
56+
<TabItem value="direct" label="Direct Download">
57+
**Direct Download**
1158

12-
First, you'll need to install the Defang CLI. The CLI is the primary way to interact with Defang. It allows you to create, deploy, and manage your services. You can find the [different installation methods here](./installing.md).
59+
You can find the latest version of the Defang CLI on the [latest release page](https://github.com/DefangLabs/defang/releases/latest). Just download the appropriate binary for your operating system and architecture, and put it somewhere in your `PATH`.
60+
</TabItem>
61+
</Tabs>
1362

1463
## Generate a project
1564

docs/getting-started/installing.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

docs/intro/features.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ Defang provides a streamlined experience to develop, deploy, observe, and update
1717
- Ability to express your project configuration using a [Docker Compose YAML](/docs/concepts/compose.md) file
1818
- Ability to manage [encrypted configuration values](/docs/concepts/configuration.md)
1919
- Pre-configured environments with built-in [security](/docs/concepts/security.md), [networking](/docs/concepts/networking.mdx), and [observability](/docs/concepts/observability.md)
20-
- [One-command deployments](/docs/getting-started/installing.md)
20+
- [One-command deployments](/docs/getting-started#install-the-defang-cli.md)
2121
- Support for [GPUs](/docs/concepts/resources.md)
2222
- Support for Infra-as-Code via the [Defang Pulumi provider](/docs/concepts/pulumi.md)

docs/intro/what-is-defang.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: What is Defang?
1010

1111
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.
1212

13-
- The [Defang CLI](/docs/getting-started/installing.md) includes an AI-driven agent that translates natural language prompts to an outline for your project that you can then refine.
13+
- 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.
1414
- Defang can automatically build and deploy your project with a single command.
1515
- 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.
1616
- 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.

docs/tutorials/deploy-to-aws.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This tutorial will show you how to deploy your services to your own AWS account
1212
* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
1313
* [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
1414
* [A Defang Account](/docs/concepts/authentication)
15-
* [The Defang CLI](/docs/getting-started/installing)
15+
* [The Defang CLI](/docs/getting-started#install-the-defang-cli)
1616
* [AWS Account Credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html)
1717

1818
## Step 1 - Navigate to your project directory

docs/tutorials/deploy-to-digitalocean.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This tutorial will show you how to deploy your services to your own DigitalOcean
1212
* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
1313
* [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
1414
* [A Defang Account](/docs/concepts/authentication)
15-
* [The Defang CLI](/docs/getting-started/installing)
15+
* [The Defang CLI](/docs/getting-started#install-the-defang-cli)
1616
* [DigitalOcean Account Credentials](/docs/providers/digitalocean#getting-started)
1717
* [DigitalOcean Spaces Access Keys](/docs/providers/digitalocean#getting-started)
1818

docs/tutorials/deploy-to-playground.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This tutorial will show you how to deploy your project to the Defang Playground.
1212
* [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
1313
* [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
1414
* [A Defang Account](/docs/concepts/authentication)
15-
* [The Defang CLI](/docs/getting-started/installing)
15+
* [The Defang CLI](/docs/getting-started#install-the-defang-cli)
1616

1717
## Step 1 - Navigate to your project directory
1818
Head to the folder where your project is located.

0 commit comments

Comments
 (0)