Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commite4c7fa6

Browse files
committed
api docgen fixes
1 parenta358cc3 commite4c7fa6

File tree

8 files changed

+28
-25
lines changed

8 files changed

+28
-25
lines changed

‎docs/admin/automation.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ All actions possible through the Coder dashboard can also be automated as it
44
utilizes the same public REST API. There are several ways to extend/automate
55
Coder:
66

7-
-[CLI](../cli.md)
8-
-[REST API](../api/)
7+
-[CLI](../reference/cli/README.md)
8+
-[REST API](../reference/api/README.md)
99
-[Coder SDK](https://pkg.go.dev/github.com/coder/coder/v2/codersdk)
1010

1111
##Quickstart
@@ -32,9 +32,10 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
3232

3333
##Documentation
3434

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

3940
##Use cases
4041

@@ -52,8 +53,8 @@ payloads, we recommend checking the CLI and API documentation.
5253
Workspace agents have a special token that can send logs, metrics, and workspace
5354
activity.
5455

55-
-[Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs): Expose
56-
messages prior to the Coder init script running (e.g. pulling image, VM
56+
-[Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs):
57+
Exposemessages prior to the Coder init script running (e.g. pulling image, VM
5758
starting, restoring snapshot).
5859
[coder-logstream-kube](https://github.com/coder/coder-logstream-kube) uses
5960
this to show Kubernetes events, such as image pulls or ResourceQuota

‎docs/admin/healthcheck.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Coder includes an operator-friendly deployment health page that provides a
44
number of details about the health of your Coder deployment.
55

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

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

‎docs/admin/provisioners.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ on the Coder server and start the provisioner with
4040
the[Helm example](#example-running-an-external-provisioner-with-helm) below.
4141

4242
>Coder still supports authenticating the provisioner daemon with a
43-
>[token](../cli.md#--token) from a user with the Template Admin or Owner role.
44-
>This method is deprecated in favor of the PSK, which only has permission to
45-
>access provisioner daemon APIs. We recommend migrating to the PSK as soon as
46-
>practical.
43+
>[token](../reference/cli.md#--token) from a user with the Template Admin or
44+
>Owner role.This method is deprecated in favor of the PSK, which only has
45+
>permission toaccess provisioner daemon APIs. We recommend migrating to the
46+
>PSK as soon aspractical.
4747
4848
##Types of provisioners
4949

‎docs/admin/scaling/scale-testing.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,14 @@ on the workload size to ensure deployment stability.
112112

113113
####CPU and memory usage
114114

115-
Enabling[agent stats collection](../../cli.md#--prometheus-collect-agent-stats)
115+
Enabling
116+
[agent stats collection](../../reference/cli.md#--prometheus-collect-agent-stats)
116117
(optional) may increase memory consumption.
117118

118119
Enabling direct connections between users and workspace agents (apps or SSH
119120
traffic) can help prevent an increase in CPU usage. It is recommended to keep
120-
[this option enabled](../../cli.md#--disable-direct-connections) unless there
121-
are compelling reasons to disable it.
121+
[this option enabled](../../reference/cli.md#--disable-direct-connections)
122+
unless thereare compelling reasons to disable it.
122123

123124
Inactive users do not consume Coder resources.
124125

‎docs/admin/workspace-proxies.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ Workspace proxies can be used in the browser by navigating to the user
2626

2727
##Requirements
2828

29-
- The[Coder CLI](../cli.md) must be installed and authenticated as a user with
30-
the Owner role.
29+
- The[Coder CLI](../reference/cli.md) must be installed and authenticated as a
30+
user withthe Owner role.
3131

3232
##Step 1: Create the proxy
3333

‎docs/reference/api/README.md

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more aboutcustomizing how changed files appear on GitHub.

‎docs/templates/agent-metadata.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ All of these examples use
1515
for the script declaration. With heredoc strings, you can script without messy
1616
escape codes, just as if you were working in your terminal.
1717

18-
Some of the examples use the[`coder stat`](../reference/cli/stat.md) command. This is
19-
useful for determining CPU and memory usage of the VM or container that the
20-
workspace is running in, which is more accurate than resource usage about the
21-
workspace's host.
18+
Some of the examples use the[`coder stat`](../reference/cli/stat.md) command.
19+
This isuseful for determining CPU and memory usage of the VM or container that
20+
theworkspace is running in, which is more accurate than resource usage about
21+
theworkspace's host.
2222

2323
Here's a standard set of metadata snippets for Linux agents:
2424

‎scripts/apidocgen/postprocess/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,12 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
3838
3939
## Use cases
4040
41-
See some common [use cases](../admin/automation.md#use-cases) for the REST API.
41+
See some common [use cases](../../admin/automation.md#use-cases) for the REST API.
4242
4343
## Sections
4444
4545
<children>
46-
This page is rendered on https://coder.com/docs/coder-oss/api. Refer to the other documents in the `+"`api/`"+` directory.
46+
This page is rendered on https://coder.com/docs/reference/api. Refer to the other documents in the `+"`api/`"+` directory.
4747
</children>
4848
`
4949
)

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp