move the authentication doc from "getting-started" to "concepts"

jordanstephens · jordanstephens · commit b02b8aaa5b2a · 2024-11-29T10:37:55.000-08:00
diff --git a/docs/concepts/accounts.md b/docs/concepts/accounts.md
@@ -16,7 +16,7 @@ Eventually, billing and payment information will be associated with your account
 
 ## Creating an Account
 
-To create an account, simply login to Defang and accept the [terms of service](https://defang.io/terms-service.html) using the [CLI](../getting-started/authenticating.md).
+To create an account, simply login to Defang and accept the [terms of service](https://defang.io/terms-service.html) using the [CLI](/docs/concepts/authentication.md).
 
 At the moment, the only way to authenticate with Defang is through GitHub. We plan to offer other authentication providers in the future.
 
@@ -34,4 +34,4 @@ Keep in mind that your Defang account is separate from your [cloud provider acco
 
 :::info
 We plan to introduce a more robust system for managing accounts, permissions, service groups, etc. in the future.
-:::
+:::
diff --git a/docs/concepts/authentication.md b/docs/concepts/authentication.md
@@ -1,10 +1,10 @@
 ---
 sidebar_position: 200
-title: Authenticating
-description: Authenticate with Defang.
+title: Authentication
+description: Authenticating with Defang.
 ---
 
-# Authenticating
+# Authenticating with Defang
 
 To do pretty much anything with Defang, you'll need to authenticate with the platform. You can do this by running the following command:
 
@@ -16,4 +16,4 @@ This will prompt you to open a browser and log into your Defang account. For now
 
 :::warning
 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.
-:::
+:::
diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md
@@ -72,7 +72,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 page](/docs/getting-started/authenticating).
+To learn more about how authentication works in defang, check out the [authenticating page](/docs/concepts/authentication).
 :::
 
 When you do this, you should see something similar to the output below:
diff --git a/docs/tutorials/deploy-to-aws.mdx b/docs/tutorials/deploy-to-aws.mdx
@@ -11,7 +11,7 @@ This tutorial will show you how to deploy your services to your own AWS account
 ## Pre-requisites
 * [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
 * [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
-* [A Defang Account](/docs/getting-started/authenticating)
+* [A Defang Account](/docs/concepts/authentication)
 * [The Defang CLI](/docs/getting-started/installing)
 * [AWS Account Credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html)
 
@@ -23,7 +23,7 @@ $ cd path/to/your/project
 
 ## Step 2 - Authenticate Defang to use your AWS Account
 
-There are many ways to authenticate your [AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html). 
+There are many ways to authenticate your [AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html).
 Once you've done that, Defang will look for your AWS credentials in your shell environment and expect to find one of the following credential sets:
 * the `AWS_PROFILE` environment variable
 * or, the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables
diff --git a/docs/tutorials/deploy-to-digitalocean.mdx b/docs/tutorials/deploy-to-digitalocean.mdx
@@ -11,7 +11,7 @@ This tutorial will show you how to deploy your services to your own DigitalOcean
 ## Pre-requisites
 * [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
 * [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
-* [A Defang Account](/docs/getting-started/authenticating)
+* [A Defang Account](/docs/concepts/authentication)
 * [The Defang CLI](/docs/getting-started/installing)
 * [DigitalOcean Account Credentials](/docs/providers/digitalocean#getting-started)
 * [DigitalOcean Spaces Access Keys](/docs/providers/digitalocean#getting-started)
diff --git a/docs/tutorials/deploy-to-playground.mdx b/docs/tutorials/deploy-to-playground.mdx
@@ -11,7 +11,7 @@ This tutorial will show you how to deploy your project to the Defang Playground.
 ## Pre-requisites
 * [A Dockerfile in your project](https://docs.docker.com/get-started/docker-concepts/building-images/writing-a-dockerfile/)
 * [A `compose.yaml` file in your project](https://docs.docker.com/compose/gettingstarted/)
-* [A Defang Account](/docs/getting-started/authenticating)
+* [A Defang Account](/docs/concepts/authentication)
 * [The Defang CLI](/docs/getting-started/installing)
 
 ## Step 1 - Navigate to your project directory
@@ -34,7 +34,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 page](/docs/getting-started/authenticating).
+To learn more about how authentication works in defang, check out the [authenticating page](/docs/concepts/authentication).
 :::
 
 When you do this, you should see something similar to the output below:
diff --git a/docs/tutorials/deploy-using-pulumi.mdx b/docs/tutorials/deploy-using-pulumi.mdx
@@ -11,7 +11,7 @@ sidebar_position: 400
 
 Make sure to install the [Pulumi CLI](https://www.pulumi.com/docs/install/) and the [Defang CLI](../getting-started/installing.md).
 
-Make sure you are logged into the [Defang CLI](../getting-started/authenticating.md). Don't worry about the Pulumi CLI for now.
+Make sure you are logged into the [Defang CLI](/docs/concepts/authentication.md). Don't worry about the Pulumi CLI for now.
 
 ## Project Directory Setup
 
diff --git a/static/samples.json b/static/samples.json
@@ -82,7 +82,7 @@
   {
     "name": "nextjs",
     "category": "nodejs",
-    "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/getting-started/authenticating)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
+    "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/concepts/authentication)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
   },
   {
     "name": "nextjs-boilerplate",
@@ -92,7 +92,7 @@
   {
     "name": "nextjs-github-actions",
     "category": "nodejs",
-    "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/getting-started/authenticating)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
+    "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/concepts/authentication)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
   },
   {
     "name": "remix-aiven-postgres",
@@ -169,4 +169,4 @@
     "category": "ruby",
     "readme": "\nThis template is a member list project developed using Ruby on Rails, offering a starting point to help you quickly build your team management system. We have prepared all the essential files for deployment. By spending less than 10 minutes setting up the environment, as detailed in the prerequisites, and executing the commands in our step-by-step guide, your website will be ready to go live to the world!\n\n## NOTE\n1. This sample showcases how you could deploy a full-stack application with Defang in Ruby on Rails. However, it uses a SQLite database, which isn't production-ready and will be reset with every deployment. For production use cases you should use a managed database like RDS, Aiven, or others. If you stick to Rail's default SQLite database, your stored data will be lost on every deployment, and in some other cases. In the future, Defang will help you provision and connect to managed databases.\n\n## Essential Setup Files\n1. A <a href=\"https://docs.docker.com/develop/develop-images/dockerfile_best-practices/\">Dockerfile</a> to describe the basic image of your applications.\n2. A <a href=\"https://docs.defang.io/docs/concepts/compose\">docker-compose file</a> to define and run multi-container Docker applications.\n3. A <a href=\"https://docs.docker.com/build/building/context/#dockerignore-files\">.dockerignore</a> file to comply with the size limit (10MB).\n\n## Prerequisite\n1. Download <a href=\"https://github.com/defang-io/defang\">Defang CLI</a>\n2. If you are using <a href=\"https://docs.defang.io/docs/concepts/defang-byoc\">Defang BYOC</a>, make sure you have properly <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html\">authenticated your AWS account</a>\nPlus, make sure that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.\n\n## A Step-by-Step Guide\n1. Open the terminal and type `defang login`\n2. Type `defang compose up` in the CLI\n3. Now your application will be launched\n"
   }
-]
+]

Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@`
`82`	`82`	`{`
`83`	`83`	`"name": "nextjs",`
`84`	`84`	`"category": "nodejs",`
`85`		- "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/getting-started/authenticating)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
	`85`	+ "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/concepts/authentication)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
`86`	`86`	`},`
`87`	`87`	`{`
`88`	`88`	`"name": "nextjs-boilerplate",`
`@@ -92,7 +92,7 @@`
`92`	`92`	`{`
`93`	`93`	`"name": "nextjs-github-actions",`
`94`	`94`	`"category": "nodejs",`
`95`		- "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/getting-started/authenticating)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
	`95`	+ "readme": "# Next.js × Defang\n\nA basic Next.js app with a Dockerfile and docker-compose ready to deploy to AWS with [Defang](https://defang.io).\n\n## Steps\n\n1. [Install Defang](https://docs.defang.io/docs/getting-started/installing)\n2. [Authenticate with Defang](https://docs.defang.io/docs/concepts/authentication)\n3. (optional) [Authenticate with AWS](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html)\n4. Run `defang compose up` in the root of this project"
`96`	`96`	`},`
`97`	`97`	`{`
`98`	`98`	`"name": "remix-aiven-postgres",`
`@@ -169,4 +169,4 @@`
`169`	`169`	`"category": "ruby",`
`170`	`170`	"readme": "\nThis template is a member list project developed using Ruby on Rails, offering a starting point to help you quickly build your team management system. We have prepared all the essential files for deployment. By spending less than 10 minutes setting up the environment, as detailed in the prerequisites, and executing the commands in our step-by-step guide, your website will be ready to go live to the world!\n\n## NOTE\n1. This sample showcases how you could deploy a full-stack application with Defang in Ruby on Rails. However, it uses a SQLite database, which isn't production-ready and will be reset with every deployment. For production use cases you should use a managed database like RDS, Aiven, or others. If you stick to Rail's default SQLite database, your stored data will be lost on every deployment, and in some other cases. In the future, Defang will help you provision and connect to managed databases.\n\n## Essential Setup Files\n1. A <a href=\"https://docs.docker.com/develop/develop-images/dockerfile_best-practices/\">Dockerfile</a> to describe the basic image of your applications.\n2. A <a href=\"https://docs.defang.io/docs/concepts/compose\">docker-compose file</a> to define and run multi-container Docker applications.\n3. A <a href=\"https://docs.docker.com/build/building/context/#dockerignore-files\">.dockerignore</a> file to comply with the size limit (10MB).\n\n## Prerequisite\n1. Download <a href=\"https://github.com/defang-io/defang\">Defang CLI</a>\n2. If you are using <a href=\"https://docs.defang.io/docs/concepts/defang-byoc\">Defang BYOC</a>, make sure you have properly <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html\">authenticated your AWS account</a>\nPlus, make sure that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.\n\n## A Step-by-Step Guide\n1. Open the terminal and type `defang login`\n2. Type `defang compose up` in the CLI\n3. Now your application will be launched\n"
`171`	`171`	`}`
`172`		`-]`
	`172`	`+]`