mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
docs: move api and cli docs routes to reference/ (#14241)
This commit is contained in:
Vendored
+4
-4
@@ -15,10 +15,10 @@ All of these examples use
|
||||
for the script declaration. With heredoc strings, you can script without messy
|
||||
escape codes, just as if you were working in your terminal.
|
||||
|
||||
Some of the examples use the [`coder stat`](../cli/stat.md) command. This is
|
||||
useful for determining CPU and memory usage of the VM or container that the
|
||||
workspace is running in, which is more accurate than resource usage about the
|
||||
workspace's host.
|
||||
Some of the examples use the [`coder stat`](../reference/cli/stat.md) command.
|
||||
This is useful for determining CPU and memory usage of the VM or container that
|
||||
the workspace is running in, which is more accurate than resource usage about
|
||||
the workspace's host.
|
||||
|
||||
Here's a standard set of metadata snippets for Linux agents:
|
||||
|
||||
|
||||
Vendored
+1
-1
@@ -27,6 +27,6 @@ coder templates push --yes $CODER_TEMPLATE_NAME \
|
||||
```
|
||||
|
||||
To cap token lifetime on creation,
|
||||
[configure Coder server to set a shorter max token lifetime](../cli/server.md#--max-token-lifetime).
|
||||
[configure Coder server to set a shorter max token lifetime](../reference/cli/server.md#--max-token-lifetime).
|
||||
For an example, see how we push our development image and template
|
||||
[with GitHub actions](https://github.com/coder/coder/blob/main/.github/workflows/dogfood.yaml).
|
||||
|
||||
Vendored
+2
-2
@@ -25,8 +25,8 @@ here!
|
||||
|
||||

|
||||
|
||||
If you prefer to use Coder on the [command line](../cli.md), use
|
||||
`coder templates init`.
|
||||
If you prefer to use Coder on the [command line](../reference/cli/README.md),
|
||||
use `coder templates init`.
|
||||
|
||||
> Coder starter templates are also available on our
|
||||
> [GitHub repo](https://github.com/coder/coder/tree/main/examples/templates).
|
||||
|
||||
Vendored
+3
-2
@@ -90,8 +90,9 @@ To create a new Terraform lock file, run the
|
||||
inside a folder containing the Terraform source code for a given template.
|
||||
|
||||
This will create a new file named `.terraform.lock.hcl` in the current
|
||||
directory. When you next run [`coder templates push`](../cli/templates_push.md),
|
||||
the lock file will be stored alongside with the other template source code.
|
||||
directory. When you next run
|
||||
[`coder templates push`](../reference/cli/templates_push.md), the lock file will
|
||||
be stored alongside with the other template source code.
|
||||
|
||||
> Note: Terraform best practices also recommend checking in your
|
||||
> `.terraform.lock.hcl` into Git or other VCS.
|
||||
|
||||
Reference in New Issue
Block a user