moved resource definition outside of user guides

coder · matifali · May 22, 2024 · May 23, 2024 · May 23, 2024 · May 23, 2024
commit d6f2a8c8f1ddc4e3a27cfcf7993f152415fa04d5
diff --git a/docs/admin/workspaces/lifecycle.md b/docs/admin/workspaces/lifecycle.md
@@ -5,9 +5,9 @@ Workspaces are flexible, reproducible, and isolated units of compute. Workspaces
 
 This page covers how workspaces move through this lifecycle. To learn about automating workspace schedules for cost control, read the [workspace scheduling docs](./schedule.md).
 
-## Resource persistence
+## Resources and persistence
 
-In Coder, your workspaces are composed of ephemeral and persistent resources. Persistent resources stay provisioned when the workspace is stopped, where as ephemeral resources are destroyed and recreated on restart. All resources are destroyed when a workspace is deleted.
+In Coder, your workspaces are composed of resources which may be _ephemeral_ or _persistent_. Persistent resources stay provisioned when the workspace is stopped, where as ephemeral resources are destroyed and recreated on restart. All resources are destroyed when a workspace is deleted.
 
 
 Ephemeral resources reduce the cost of stopped workspaces and ensure reproducibility of your environments.
@@ -37,23 +37,29 @@ By default, there is no limit on the number of workspaces a user may create, reg
 
 When a user creates a workspace, they're sending a build request to the control plane. Coder takes this and uses [Terraform](https://www.terraform.io/) to provision a workspace defined by your [template](../templates/README.md). Generally, templates define the resources and environment of a workspace.  
 
-Once the workspace is provisioned, the agent process starts and opens connections to your workspace via SSH, the terminal, and IDES like [JetBrains](../../user-guides/workspace-access/jetbrains.md) or [VSCode](../../user-guides/workspace-access/vscode.md). 
 
-The agent is responsible for running your workspace startup scripts. These may configure tools, service connections, or personalization like [dotfiles](../../user-guides/workspace-dotfiles.md).
+The resources that run the agent are described as _computational resources_,
+while those that don't are called _peripheral resources_. A workspace must contain some computational resource to run the Coder agent process.
+
+The provisioned workspace's computational resources start the agent process, which opens connections to your workspace via SSH, the terminal, and IDES like [JetBrains](../../user-guides/workspace-access/jetbrains.md) or [VSCode](../../user-guides/workspace-access/vscode.md). 
+
+Once started, the Coder agent is responsible for running your workspace startup scripts. These may configure tools, service connections, or personalization like [dotfiles](../../user-guides/workspace-dotfiles.md).
+
+
+
+Once these steps have completed, your workspace will now be in the `Running` state. You can access it via any of the [supported methods](../../user-guides/workspace-access/README.md), stop it when you're away, or delete it once it's no longer in use.
 
 ## Stopping workspaces
 
 Workspaces may be stopped manually by users and admins in the dashboard, CLI, or API. Workspaces may be automatically stopped by scheduling configuration to reduce the uptime of costly resources.
 
 
 
-## Workspace deletion
-
+## Deleting workspaces
 
-## Ephemeral workspaces
 
+## Unhealthy and Failed workspaces
 
-### Dormant workspaces
 
 
 

diff --git a/docs/user-guides/README.md b/docs/user-guides/README.md
@@ -6,11 +6,7 @@ At the highest level, a workspace is a set of cloud resources. These resources
 can be VMs, Kubernetes clusters, storage buckets, or whatever else [Terraform](https://developer.hashicorp.com/terraform/docs)
 lets you dream up.
 
-The resources that run the agent are described as _computational resources_,
-while those that don't are called _peripheral resources_.
 
-Each resource may also be _persistent_ or _ephemeral_ depending on whether
-they're destroyed on workspace stop.
 
 Coder Workspaces are managed by the workspace agent, which facilitates [connections](./workspace-access.md).