Thanks to visit codestin.com
Credit goes to github.com

Skip to content

chore: reorganize some docs #7062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 12, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
3 changes: 1 addition & 2 deletions docs/admin/configure.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
30 changes: 15 additions & 15 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand All @@ -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": [
{
Expand Down Expand Up @@ -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",
Expand All @@ -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"
}
]
},
Expand Down Expand Up @@ -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": [
{
Expand Down
8 changes: 4 additions & 4 deletions docs/networking.md → docs/networking/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -131,4 +131,4 @@ INTERVAL TRANSFER BANDWIDTH

## Up next

- Learn about [Port Forwarding](./networking/port-forwarding.md)
- Learn about [Port Forwarding](./port-forwarding.md)
File renamed without changes.
24 changes: 12 additions & 12 deletions docs/templates.md → docs/templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -296,7 +296,7 @@ coder templates delete <template-name>
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

Expand All @@ -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
Expand Down Expand Up @@ -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`
Expand Down Expand Up @@ -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)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Docker in Docker
# Docker in Workspaces

There are a few ways to run Docker within container-based Coder workspaces.

Expand Down