diff --git a/docs/admin/index.md b/docs/admin/README.md similarity index 100% rename from docs/admin/index.md rename to docs/admin/README.md diff --git a/docs/admin/configure.md b/docs/admin/configure.md index 281c1dbc6c..10232e23ef 100644 --- a/docs/admin/configure.md +++ b/docs/admin/configure.md @@ -1,5 +1,4 @@ -Coder server's primary configuration is done via environment variables. For a full list -of the options, run `coder server --help` on the host. +Coder server's primary configuration is done via environment variables. For a full list of the options, run `coder server --help` or see our [CLI documentation](../cli/server.md). ## Access URL diff --git a/docs/manifest.json b/docs/manifest.json index 7b2c837cc2..47b72e3625 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -76,15 +76,9 @@ { "title": "Platforms", "description": "Platform-specific guides using Coder", - "path": "./platforms.md", + "path": "./platforms/README.md", "icon_path": "./images/icons/star.svg", "children": [ - { - "title": "Docker", - "description": "Set up Coder with Docker", - "path": "./platforms/docker.md", - "icon_path": "./images/icons/docker.svg" - }, { "title": "AWS", "description": "Set up Coder on an AWS EC2 VM", @@ -115,6 +109,12 @@ } ] }, + { + "title": "Docker", + "description": "Set up Coder with Docker", + "path": "./platforms/docker.md", + "icon_path": "./images/icons/docker.svg" + }, { "title": "Other platforms", "description": "Set up Coder on an another provider", @@ -125,7 +125,7 @@ { "title": "Templates", "description": "Learn about templates, which define the infrastructure underlying workspaces", - "path": "./templates.md", + "path": "./templates/README.md", "icon_path": "./images/icons/picture.svg", "children": [ { @@ -159,12 +159,6 @@ "icon_path": "./images/icons/table-rows.svg", "state": "alpha" }, - { - "title": "Docker in Docker", - "description": "Use docker inside containerized templates", - "path": "./templates/docker-in-docker.md", - "icon_path": "./images/icons/docker.svg" - }, { "title": "Parameters", "description": "Use parameters to customize templates", @@ -176,6 +170,12 @@ "description": "Learn how to add an \"Open in Coder\" button to your repos", "path": "./templates/open-in-coder.md", "icon_path": "./images/icons/key.svg" + }, + { + "title": "Docker in Workspaces", + "description": "Use docker inside containerized templates", + "path": "./templates/docker-in-workspaces.md", + "icon_path": "./images/icons/docker.svg" } ] }, @@ -241,7 +241,7 @@ { "title": "Administration", "description": "How to install and deploy Coder", - "path": "./admin/index.md", + "path": "./admin/README.md", "icon_path": "./images/icons/wrench.svg", "children": [ { diff --git a/docs/networking.md b/docs/networking/README.md similarity index 93% rename from docs/networking.md rename to docs/networking/README.md index 6e1012f415..63bb972640 100644 --- a/docs/networking.md +++ b/docs/networking/README.md @@ -51,12 +51,12 @@ is no special geo-distribution configuration. To speed up direct connections, move the user and workspace closer together. If a direct connection is not available (e.g. client or server is behind NAT), Coder -will use a relayed connection. By default, [Coder uses Google's public STUN server](./cli/server.md#--derp-server-stun-addresses), but -this can be disabled or changed for [offline deployments](./install/offline.md). +will use a relayed connection. By default, [Coder uses Google's public STUN server](../cli/server#--derp-server-stun-addresses), but +this can be disabled or changed for [offline deployments](../install/offline.md). ### Relayed connections -By default, your Coder server also runs a built-in DERP relay which can be used for both public and [offline deployments](./install/offline.md). +By default, your Coder server also runs a built-in DERP relay which can be used for both public and [offline deployments](../install/offline.md). However, Tailscale has graciously allowed us to use [their global DERP relays](https://tailscale.com/kb/1118/custom-derp-servers/#what-are-derp-servers). You can launch `coder server` with Tailscale's DERPs like so: @@ -131,4 +131,4 @@ INTERVAL TRANSFER BANDWIDTH ## Up next -- Learn about [Port Forwarding](./networking/port-forwarding.md) +- Learn about [Port Forwarding](./port-forwarding.md) diff --git a/docs/platforms.md b/docs/platforms/README.md similarity index 100% rename from docs/platforms.md rename to docs/platforms/README.md diff --git a/docs/templates.md b/docs/templates/README.md similarity index 94% rename from docs/templates.md rename to docs/templates/README.md index 8b9fde39f8..6830f6df3f 100644 --- a/docs/templates.md +++ b/docs/templates/README.md @@ -6,7 +6,7 @@ kubernetes_pod). In most cases, a small group of users (team leads or Coder administrators) [have permissions](./admin/users.md#roles) to create and manage templates. Then, other -users provision their [workspaces](./workspaces.md) from templates using the UI +users provision their [workspaces](../workspaces.md) from templates using the UI or CLI. ## Get the CLI @@ -149,7 +149,7 @@ for the full list of supported arguments for the `coder_agent`. #### startup_script Use the Coder agent's `startup_script` to run additional commands like -installing IDEs, [cloning dotfiles](./dotfiles.md#templates), and cloning +installing IDEs, [cloning dotfiles](../dotfiles.md#templates), and cloning project repos. ```hcl @@ -187,7 +187,7 @@ coder dotfiles -y ${var.dotfiles_uri} ### Start/stop -[Learn about resource persistence in Coder](./templates/resource-persistence.md) +[Learn about resource persistence in Coder](./resource-persistence.md) Coder workspaces can be started/stopped. This is often used to save on cloud costs or enforce ephemeral workflows. When a workspace is started or stopped, @@ -246,7 +246,7 @@ resource "kubernetes_pod" "podName" { ### Edit templates You can edit a template using the coder CLI. Only [template admins and -owners](./admin/users.md) can edit a template. +owners](../admin/users.md) can edit a template. Using the CLI, login to Coder and run the following command to edit a single template: @@ -283,7 +283,7 @@ prompt in the dashboard to update. ### Delete templates You can delete a template using both the coder CLI and UI. Only [template admins -and owners](./admin/users.md) can delete a template, and the template must not +and owners](../admin/users.md) can delete a template, and the template must not have any running workspaces associated to it. Using the CLI, login to Coder and run the following command to delete a @@ -296,7 +296,7 @@ coder templates delete In the UI, navigate to the template you want to delete, and select the dropdown in the right-hand corner of the page to delete the template. -![delete-template](./images/delete-template.png) +![delete-template](../images/delete-template.png) #### Delete workspaces @@ -313,7 +313,7 @@ associated with the workspace. ### Coder apps By default, all templates allow developers to connect over SSH and a web -terminal. See [Configuring Web IDEs](./ides/web-ides.md) to learn how to give +terminal. See [Configuring Web IDEs](../ides/web-ides.md) to learn how to give users access to additional web applications. ### Data source @@ -362,7 +362,7 @@ practices: - Ensure the resource has `curl` installed (alternatively, `wget` or `busybox`) - Ensure the resource can `curl` your Coder [access - URL](./admin/configure.md#access-url) + URL](../admin/configure.md#access-url) - Manually connect to the resource and check the agent logs (e.g., `kubectl exec`, `docker exec` or AWS console) - The Coder agent logs are typically stored in `/tmp/coder-agent.log` - The Coder agent startup script logs are typically stored in `/tmp/coder-startup-script.log` @@ -412,7 +412,7 @@ You can see a list of community templates by our users ## Next Steps -- Learn about [Authentication & Secrets](templates/authentication.md) -- Learn about [Change Management](templates/change-management.md) -- Learn about [Resource Metadata](templates/resource-metadata.md) -- Learn about [Workspaces](workspaces.md) +- Learn about [Authentication & Secrets](./authentication.md) +- Learn about [Change Management](./change-management.md) +- Learn about [Resource Metadata](./resource-metadata.md) +- Learn about [Workspaces](./workspaces.md) diff --git a/docs/templates/docker-in-docker.md b/docs/templates/docker-in-workspaces.md similarity index 99% rename from docs/templates/docker-in-docker.md rename to docs/templates/docker-in-workspaces.md index 0999ff23b7..42e61fa054 100644 --- a/docs/templates/docker-in-docker.md +++ b/docs/templates/docker-in-workspaces.md @@ -1,4 +1,4 @@ -# Docker in Docker +# Docker in Workspaces There are a few ways to run Docker within container-based Coder workspaces.