Merge branch 'main' of https://github.com/invertase/globe_cli into pa…

…tch-1

docs.yaml

@@ -18,47 +18,47 @@ sidebar:
   - - - CLI Overview
       - "/cli"
     - - Deploy
-      - "/cli.commands.deploy"
+      - "/cli/commands/deploy"
     - - Link
-      - "/cli.commands.link"
+      - "/cli/commands/link"
+    - - Unlink
+      - "/cli/commands/unlink"
     - - Login
-      - "/cli.commands.login"
+      - "/cli/commands/login"
     - - Logout
-      - "/cli.commands.logout"
-    - - Unlink
-      - "/cli.commands.unlink"
+      - "/cli/commands/logout"
 - - Deployments
   - - - Overview
       - "/deployments"
     - - Build Settings
-      - "/deployments.build-settings"
+      - "/deployments/build-settings"
     - - Domains
-      - "/deployments.domains"
+      - "/deployments/domains"
     - - Environment Variables
-      - "/deployments.environment-variables"
+      - "/deployments/environment-variables"
     - - GitHub Integration
-      - "/deployments.github-integration"
+      - "/deployments/github-integration"
     - - Hooks
-      - "/deployments.hooks"
+      - "/deployments/hooks"
     - - Redeployments
-      - "/deployments.redeployments"
+      - "/deployments/redeployments"
 - - Frameworks
   - - - Overview
       - "/frameworks"
     - - Dart Frog
-      - "/frameworks.dart-frog"
+      - "/frameworks/dart-frog"
     - - Jaspr
-      - "/frameworks.jaspr"
+      - "/frameworks/jaspr"
 - - Infrastructure
   - - - Overview
       - "/infrastructure"
     - - Cold Starts
-      - "/infrastructure.cold-starts"
+      - "/infrastructure/cold-starts"
     - - Cron Jobs
-      - "/infrastructure.cron-jobs"
+      - "/infrastructure/cron-jobs"
     - - Headers
-      - "/infrastructure.headers"
+      - "/infrastructure/headers"
     - - Regions
-      - "/infrastructure.regions"
+      - "/infrastructure/regions"
     - - WebSockets
-      - "/infrastructure.websockets"
+      - "/infrastructure/websockets"

docs/cli.commands.deploy.mdx → docs/cli/commands/deploy.mdx

@@ -7,7 +7,7 @@ description: Deploy your Dart application to Globe directly from the command lin
 
 The `deploy` command allows you to deploy your Dart application to Globe directly from the command line.
 
-If you have not yet [linked a project](/docs/cli/commands/link), you will be prompted to do so before deploying.
+If you have not yet [linked a project](/cli/commands/link), you will be prompted to do so before deploying.
 
 ## Usage
 
@@ -19,7 +19,7 @@ globe deploy
 
 The CLI will upload your project to Globe and trigger a new deployment. Upon success, you will provided a URL to view deployment progress on the Globe dashboard.
 
-By default, deployments via the `deploy` command are treated as a preview deployment. This means that once deployed, the deployment will have it's own unique URL generated by Globe.
+By default, deployments via the `deploy` command are treated as a preview deployment. This means that once deployed, the deployment will have its own unique URL generated by Globe.
 To deploy as a production deployment, append the `--prod` flag to the command.
 
 ```bash
@@ -28,10 +28,10 @@ globe deploy --prod
 
 When successfully built, the deployment will be promoted to production and will be accessible via the project's primary domain(s).
 
-You can learn more about [preview and production deployments](/docs/deployments) in the deployments documentation.
+You can learn more about [preview and production deployments](/deployments) in the deployments documentation.
 
 ### Flags
 
-The command has flags (in addition to [global flags](/docs/cli)) that can be used to modify the behavior of the command, which can be accessed by running `globe deploy --<flag>`:
+The command has flags (in addition to [global flags](/cli#global-flags)) that can be used to modify the behavior of the command, which can be accessed by running `globe deploy --<flag>`:
 
-- `--prod` - Creates a deployment which will be promoted to production once built.
+- `--prod` - Creates a deployment that will be promoted to production once built.

docs/cli.commands.link.mdx → docs/cli/commands/link.mdx

@@ -6,7 +6,7 @@ title: Link a project to Globe
 
 The `link` command links a local Dart project to a Globe project. Linking is required to deploy a project to Globe.
 
-Project linking is carried out automatically if the project is not yet linked when running the [`deploy`](/docs/cli/commands/deploy) command.
+Project linking is carried out automatically if the project is not yet linked when running the [`deploy`](/cli/commands/deploy) command.
 
 ## Usage
 
@@ -16,14 +16,14 @@ globe link
 
 The `link` command will first prompt, asking whether you wish to continue linking the local project. If you continue, you will be further prompted to:
 
-1. Select an account you wish to link this project to.
-2. Select, or create a new project to link this project to.
+1. Select an account you wish to link this local project to.
+2. Select, or create a new project to link this local project to.
 
-Upon completion, the project will be linked to your Globe account and you will be able to deploy the project.
+Upon completion, the local project will be linked to your Globe account and you will be able to deploy it.
 
-## Details
+## How it works
 
 A linked project stores metadata about the project in the local `.dart_tool/dart_globe` directory on your machine. This metadata is used to identify the project when deploying to Globe. If not already,
 the `.dart_tool` directory should not be committed to your Git repository. You can add this directory to your `.gitignore` file to ensure it is not committed.
 
-If you accidentally delete this directory, or run the [`unlink`](/docs/cli/commands/unlink) command, you will need to re-link the project before you can deploy again.
+If you accidentally delete this directory or run the [`unlink`](/cli/commands/unlink) command, you will need to re-link the project before you can deploy again.

docs/cli.commands.login.mdx → docs/cli/commands/login.mdx

@@ -15,7 +15,7 @@ globe login
 A new browser window will open prompting you to login to your Globe account. Once you have logged in, you will be redirected to a page notifying you of a successful login. You can close this page once complete.
 Globe will store a secure token on your local machine to authenticate future requests.
 
-If you wish to [logout](/docs/cli/commands/logout), you can run the following command:
+If you wish to [logout](/cli/commands/logout), you can run the following command:
 
 ```bash
 globe logout

docs/cli/commands/logout.mdx

@@ -0,0 +1,15 @@
+---
+title: Logout of Globe
+---
+
+# Logout
+
+The `logout` command removes any prior authentication tokens from your local machine. Once you have logged out, you will need to login again before you can deploy any projects.
+
+## Usage
+
+```bash
+globe logout
+```
+
+A message will be displayed notifying you that you have been logged out.

docs/cli.commands.unlink.mdx → docs/cli/commands/unlink.mdx

@@ -12,6 +12,6 @@ The `unlink` command removes any previously linked projects from the current loc
 globe unlink
 ```
 
-## Details
+## How it works
 
 The command removes the `.dart_tool/dart_globe` directory from the local project. This directory stores metadata about the project, which is used to identify the project when deploying to Globe.

docs/deployments.build-settings.mdx → docs/deployments/build-settings.mdx

@@ -4,39 +4,39 @@ title: Build Settings
 
 # Build Settings
 
-Build settings allow you to configure how your project is build during a new deployment. You can configure your build settings via the dashboard: **Project** -> **Settings** -> **General**.
+Build settings allow you to configure how your project is built during a new deployment. You can configure your build settings via the dashboard: **Project** -> **Settings** -> **General**.
 
 ![Project Settings](/assets/project-settings.png)
 
 ## Settings
 
 You can configure the following build settings:
 
-- [Dart Version](#dart-version)
-- [Root Directory](#root-directory)
-- [Framework Preset](#framework-preset)
-- [Build Command](#build-command)
-- [Entrypoint](#entrypoint)
+- [Dart Version](/deployments/build-settings#dart-version)
+- [Root Directory](/deployments/build-settings#root-directory)
+- [Framework Preset](/deployments/build-settings#framework-preset)
+- [Build Command](/deployments/build-settings#build-command)
+- [Entrypoint](/deployments/build-settings#entrypoint)
 
 ---
 
 ### Dart Version
 
-The Dart version to use when building your project. By default, Globe will use the latest stable version of Dart. Currently Dart supports `stable` and `beta` version branches.
+The Dart version to use when building your project. By default, Globe will use the latest stable version of Dart. Currently, Dart supports `stable` and `beta` version branches.
 
 Support for specific tagged versions is coming soon.
 
 ---
 
 ### Root Directory
 
-The root directory is the directory which contains your project source. If working with mono-repositories of a directory structure where your application is not at the root where the `pubspec.yaml` file exists.
+The root directory is the directory that contains your project source. If working with mono-repositories of a directory structure where your application is not at the root where the `pubspec.yaml` file exists.
 
 ---
 
 ### Framework Preset
 
-Globe supports existing [frameworks](/docs/frameworks). If a framework is specified here, Globe will use default values required to build and deploy your framework application. If you'd like to override these values, you can do so by specifying a value in the specific build settings.
+Globe supports existing [frameworks](/frameworks). If a framework is specified here, Globe will use the default values required to build and deploy your framework application. If you'd like to override these values, you can do so by specifying a value in the specific build settings.
 
 ---
 
@@ -50,7 +50,7 @@ If using a **Framework Preset**, a default value will be used instead. You can o
 
 ### Entrypoint
 
-When building your application, the build system requires an entrypoint file which is used to bootstrap your application. The is typically the `lib/main.dart` file in your project
+When building your application, the build system requires an entrypoint file which is used to bootstrap your application. This is typically the `lib/main.dart` file in your project
 which contains a `main` function.
 
 This setting can be configured if your application uses a different entrypoint file.

docs/deployments.domains.mdx → docs/deployments/domains.mdx

@@ -6,7 +6,7 @@ title: Domains
 
 A domain is the address of your deployment.
 
-Each deployment, production or preview gets assigned a unique domain which directly points to the specific deployment. If the deployment is not yet ready or successful, visiting a domain will redirect you to the dashboard for that deployment.
+Each deployment, production or preview gets assigned a unique domain that directly points to the specific deployment. If the deployment is not yet ready or successful, visiting a domain will redirect you to the dashboard for that deployment.
 
 ## Production domains
 

docs/deployments.environment-variables.mdx → docs/deployments/environment-variables.mdx

@@ -4,7 +4,7 @@ title: Environment Variables
 
 # Environment Variables
 
-Environment variables are a set of named values that can affect the way running processes will behave on a deployment. An environment variable can be used to store secret values which are not safe to be stored in the codebase. You may wish to use
+Environment variables are a set of named values that can affect the way running processes will behave on a deployment. An environment variable can be used to store secret values that are not safe to be stored in the codebase. You may wish to use
 different values for different environments, such as development, preview, and production to connect to different databases or API endpoints.
 
 ## Creating environment variables

docs/deployments/hooks.mdx

@@ -0,0 +1,10 @@
+---
+title: Deployment Hooks
+---
+
+# Deployment Hooks
+
+Deployment hooks allow you to provide a webhook endpoint that will be called throughout the lifecycle of a deployment, for example
+when a deployment is created, built, or deployed.
+
+Deployment hooks are in development feature and will be available soon.

docs/deployments/index.mdx

@@ -0,0 +1,51 @@
+---
+title: Deploying to Globe
+---
+
+# Deployments
+
+A deployment can be triggered when you wish to deploy new code to your Globe project. In Globe, a deployment can be staged to two environments; [Production](/deployments#creating-a-production-deployment) or [Preview](/deployments#creating-a-preview-deployment).
+When a Production deployment has been successfully built, your domains will be updated automatically to point to the new deployment. Preview deployments on the other hand are accessible
+via a URL unique to the deployment. This allows you to test and share your changes on a live environment before deploying to production.
+
+![Deployments](/assets/deployments.png)
+
+Once deployments have been successfully built, you can access the unique URL from the Globe dashboard.
+
+## Creating a preview deployment
+
+To create a new preview deployment, you have two options:
+
+### via the CLI
+
+Run the [`deploy`](/cli/commands/deploy) command. By default, deployments from the CLI are staged as a preview deployment:
+
+```bash
+globe deploy
+```
+
+### via GitHub
+
+Using the [GitHub Integration](/deployments/github-integration), you can trigger a preview deployment by pushing to a branch that
+is not defined as the production branch in your project settings.
+
+To learn more, view the [GitHub Integration](/deployments/github-integration) documentation.
+
+## Creating a production deployment
+
+To create a new production deployment, you have two options:
+
+### via the CLI
+
+Run the [`deploy`](/cli/commands/deploy) command with the `--prod` flag:
+
+```bash
+globe deploy --prod
+```
+
+### via GitHub
+
+Using the [GitHub Integration](/deployments/github-integration), you can trigger a production deployment by pushing to the branch
+specified in your project settings. By default, this is the `main` branch.
+
+To learn more, view the [GitHub Integration](/deployments/github-integration) documentation.