Skip to content

docs: move api and cli docs routes to reference/ #14241

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 16 commits into from
Aug 13, 2024
Prev Previous commit
Next Next commit
more fixing
  • Loading branch information
matifali committed Aug 13, 2024
commit cc226a8e10998eb592479adfac79f4e5cb403e9d
2 changes: 1 addition & 1 deletion docs/admin/audit-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ audit trails.

Audit logs can be accessed through our REST API. You can find detailed
information about this in our
[endpoint documentation](../api/audit.md#get-audit-logs).
[endpoint documentation](../reference/api/audit.md#get-audit-logs).

## Service Logs

Expand Down
6 changes: 3 additions & 3 deletions docs/admin/automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \

## Documentation

We publish an [API reference](../api/index.md) in our documentation. You can
We publish an [API reference](../reference/api/README.md) in our documentation. You can
also enable a [Swagger endpoint](../reference/cli/server.md#--swagger-enable) on
your Coder deployment.

Expand All @@ -52,7 +52,7 @@ payloads, we recommend checking the CLI and API documentation.
Workspace agents have a special token that can send logs, metrics, and workspace
activity.

- [Custom workspace logs](../api/agents.md#patch-workspace-agent-logs): Expose
- [Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs): Expose
messages prior to the Coder init script running (e.g. pulling image, VM
starting, restoring snapshot).
[coder-logstream-kube](https://github.com/coder/coder-logstream-kube) uses
Expand All @@ -73,7 +73,7 @@ activity.
}"
```

- [Manually send workspace activity](../api/agents.md#submit-workspace-agent-stats):
- [Manually send workspace activity](../reference/api/agents.md#submit-workspace-agent-stats):
Keep a workspace "active," even if there is not an open connection (e.g. for a
long-running machine learning job).

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/configure.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
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).
[CLI documentation](../reference/cli/server.md).

## Access URL

Expand Down
22 changes: 12 additions & 10 deletions docs/admin/encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Additional database fields may be encrypted in the future.

- Ensure you have a valid backup of your database. **Do not skip this step.** If
you are using the built-in PostgreSQL database, you can run
[`coder server postgres-builtin-url`](../cli/server_postgres-builtin-url.md)
[`coder server postgres-builtin-url`](../reference/cli/server_postgres-builtin-url.md)
to get the connection URL.

- Generate a 32-byte random key and base64-encode it. For example:
Expand Down Expand Up @@ -110,13 +110,13 @@ data:
encrypted with the old key(s).

- To re-encrypt all encrypted database fields with the new key, run
[`coder server dbcrypt rotate`](../cli/server_dbcrypt_rotate.md). This command
will re-encrypt all tokens with the specified new encryption key. We recommend
performing this action during a maintenance window.
[`coder server dbcrypt rotate`](../reference/cli/server_dbcrypt_rotate.md).
This command will re-encrypt all tokens with the specified new encryption key.
We recommend performing this action during a maintenance window.

> Note: this command requires direct access to the database. If you are using
> the built-in PostgreSQL database, you can run
> [`coder server postgres-builtin-url`](../cli/server_postgres-builtin-url.md)
> [`coder server postgres-builtin-url`](../reference/cli/server_postgres-builtin-url.md)
> to get the connection URL.

- Once the above command completes successfully, remove the old encryption key
Expand All @@ -132,8 +132,9 @@ To disable encryption, perform the following actions:
- Stop all active coderd instances. This will prevent new encrypted data from
being written, which may cause the next step to fail.

- Run [`coder server dbcrypt decrypt`](../cli/server_dbcrypt_decrypt.md). This
command will decrypt all encrypted user tokens and revoke all active
- Run
[`coder server dbcrypt decrypt`](../reference/cli/server_dbcrypt_decrypt.md).
This command will decrypt all encrypted user tokens and revoke all active
encryption keys.

> Note: for `decrypt` command, the equivalent environment variable for
Expand All @@ -159,9 +160,10 @@ To delete all encrypted data from your database, perform the following actions:
- Stop all active coderd instances. This will prevent new encrypted data from
being written.

- Run [`coder server dbcrypt delete`](../cli/server_dbcrypt_delete.md). This
command will delete all encrypted user tokens and revoke all active encryption
keys.
- Run
[`coder server dbcrypt delete`](../reference/cli/server_dbcrypt_delete.md).
This command will delete all encrypted user tokens and revoke all active
encryption keys.

- Remove all
[external token encryption keys](../reference/cli/server.md#--external-token-encryption-keys)
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/healthcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Coder includes an operator-friendly deployment health page that provides a
number of details about the health of your Coder deployment.

You can view it at `https://${CODER_URL}/health`, or you can alternatively view
the [JSON response directly](../api/debug.md#debug-info-deployment-health).
the [JSON response directly](../reference/api/debug.md#debug-info-deployment-health).

The deployment health page is broken up into the following sections:

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/provisioners.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ For example, running 30 provisioner containers will allow 30 users to start
workspaces at the same time.

Provisioners are started with the
[coder provisionerd start](../cli/provisionerd_start.md) command.
[coder provisionerd start](../reference/cli/provisionerd_start.md) command.

## Authentication

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/validated-arch.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ could affect workspace users experience once the platform is live.
identify the required values for deployment.
1. Create a `values.yaml` and add it to your version control system.
1. Determine the necessary environment variables. Here is the
[full list of supported server environment variables](../cli/server.md).
[full list of supported server environment variables](../reference/cli/server.md).
1. Follow our documented
[steps for installing Coder via Helm](../install/kubernetes.md).

Expand Down
4 changes: 2 additions & 2 deletions docs/networking/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ In order for clients to be able to establish direct connections:
`coder port-forward`). Note that the
[VSCode extension](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote)
and [JetBrains Plugin](https://plugins.jetbrains.com/plugin/19620-coder/), and
[`ssh coder.<workspace>`](../cli/config-ssh.md) all utilize the CLI to
establish a workspace connection.
[`ssh coder.<workspace>`](../reference/cli/config-ssh.md) all utilize the CLI
to establish a workspace connection.
- Either the client or workspace agent are able to discover a reachable
`ip:port` of their counterpart. If the agent and client are able to
communicate with each other using their locally assigned IP addresses, then a
Expand Down