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

Skip to content

Commit 687b015

Browse files
committed
wip
1 parent f97ce22 commit 687b015

File tree

30 files changed

+704
-635
lines changed

30 files changed

+704
-635
lines changed

.markdownlint.json

Lines changed: 0 additions & 18 deletions
This file was deleted.

.markdownlint.jsonc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Example markdownlint configuration with all properties set to their default value
2+
{
3+
"MD010": { "spaces_per_tab": 4}, // No hard tabs: we use 4 spaces per tab
4+
5+
"MD013": false, // Line length: we are not following a strict line lnegth in markdown files
6+
7+
"MD024": { "siblings_only": true }, // Multiple headings with the same content:
8+
9+
"MD033": false, // Inline HTML: we use it in some places
10+
11+
"MD041": false, // First line in file should be a top level heading: All of our changelogs do not start with a top level heading
12+
// TODO: We need to update /home/coder/repos/coder/coder/scripts/release/generate_release_notes.sh to generate changelogs that follow this rule
13+
14+
"MD052": false, // Image reference: docs/reference/cli/server.md#L628 is not a valid reference
15+
16+
"MD055": false, // Table pipe style: Some of the generated tables do not have ending pipes
17+
// docs/admin/security/audit-logs.md
18+
// docs/reference/api/schema.md
19+
// docs/reference/api/templates.md
20+
// docs/reference/cli/server.md
21+
22+
"MD056": false // Table column count
23+
}

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
<!-- markdownlint-disable MD041 -->
12
[https://coder.com/docs/contributing/CODE_OF_CONDUCT](https://coder.com/docs/contributing/CODE_OF_CONDUCT)

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1+
<!-- markdownlint-disable MD041 -->
12
[https://coder.com/docs/CONTRIBUTING](https://coder.com/docs/CONTRIBUTING)

Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -670,9 +670,6 @@ site/src/theme/icons.json: $(wildcard scripts/gensite/*) $(wildcard site/static/
670670

671671
examples/examples.gen.json: scripts/examplegen/main.go examples/examples.go $(shell find ./examples/templates)
672672
go run ./scripts/examplegen/main.go > examples/examples.gen.json
673-
cd site
674-
../scripts/pnpm_install.sh
675-
pnpm exec biome format --write ../examples/examples.gen.json
676673

677674
coderd/rbac/object_gen.go: scripts/typegen/rbacobject.gotmpl scripts/typegen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
678675
tempdir=$(shell mktemp -d /tmp/typegen_rbac_object.XXXXXX)

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdownlint-disable MD041 -->
12
<div align="center">
23
<a href="https://coder.com#gh-light-mode-only">
34
<img src="./docs/images/logo-black.png" alt="Coder Logo Light" style="width: 128px">

docs/admin/infrastructure/scale-utility.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,14 @@ specified template and extra parameters.
4848

4949
```shell
5050
coder exp scaletest create-workspaces \
51-
--retry 5 \
52-
--count "${SCALETEST_PARAM_NUM_WORKSPACES}" \
53-
--template "${SCALETEST_PARAM_TEMPLATE}" \
54-
--concurrency "${SCALETEST_PARAM_CREATE_CONCURRENCY}" \
55-
--timeout 5h \
56-
--job-timeout 5h \
57-
--no-cleanup \
58-
--output json:"${SCALETEST_RESULTS_DIR}/create-workspaces.json"
51+
--retry 5 \
52+
--count "${SCALETEST_PARAM_NUM_WORKSPACES}" \
53+
--template "${SCALETEST_PARAM_TEMPLATE}" \
54+
--concurrency "${SCALETEST_PARAM_CREATE_CONCURRENCY}" \
55+
--timeout 5h \
56+
--job-timeout 5h \
57+
--no-cleanup \
58+
--output json:"${SCALETEST_RESULTS_DIR}/create-workspaces.json"
5959

6060
# Run `coder exp scaletest create-workspaces --help` for all usage
6161
```
@@ -79,14 +79,14 @@ Terminal against those workspaces.
7979
```shell
8080
# Produce load at about 1000MB/s (25MB/40ms).
8181
coder exp scaletest workspace-traffic \
82-
--template "${SCALETEST_PARAM_GREEDY_AGENT_TEMPLATE}" \
83-
--bytes-per-tick $((1024 * 1024 * 25)) \
84-
--tick-interval 40ms \
85-
--timeout "$((delay))s" \
86-
--job-timeout "$((delay))s" \
87-
--scaletest-prometheus-address 0.0.0.0:21113 \
88-
--target-workspaces "0:100" \
89-
--trace=false \
82+
--template "${SCALETEST_PARAM_GREEDY_AGENT_TEMPLATE}" \
83+
--bytes-per-tick $((1024 * 1024 * 25)) \
84+
--tick-interval 40ms \
85+
--timeout "$((delay))s" \
86+
--job-timeout "$((delay))s" \
87+
--scaletest-prometheus-address 0.0.0.0:21113 \
88+
--target-workspaces "0:100" \
89+
--trace=false \
9090
--output json:"${SCALETEST_RESULTS_DIR}/traffic-${type}-greedy-agent.json"
9191
```
9292

@@ -114,8 +114,8 @@ wish to clean up all workspaces, you can run the following command:
114114

115115
```shell
116116
coder exp scaletest cleanup \
117-
--cleanup-job-timeout 2h \
118-
--cleanup-timeout 15min
117+
--cleanup-job-timeout 2h \
118+
--cleanup-timeout 15min
119119
```
120120

121121
This will delete all workspaces and users with the prefix `scaletest-`.

docs/admin/monitoring/notifications/index.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -171,33 +171,33 @@ Here is an example payload for Coder's webhook notification:
171171

172172
```json
173173
{
174-
"_version": "1.0",
175-
"msg_id": "88750cad-77d4-4663-8bc0-f46855f5019b",
176-
"payload": {
177-
"_version": "1.0",
178-
"notification_name": "Workspace Deleted",
179-
"user_id": "4ac34fcb-8155-44d5-8301-e3cd46e88b35",
180-
"user_email": "[email protected]",
181-
"user_name": "danny",
182-
"user_username": "danny",
183-
"actions": [
184-
{
185-
"label": "View workspaces",
186-
"url": "https://et23ntkhpueak.pit-1.try.coder.app/workspaces"
187-
},
188-
{
189-
"label": "View templates",
190-
"url": "https://et23ntkhpueak.pit-1.try.coder.app/templates"
191-
}
192-
],
193-
"labels": {
194-
"initiator": "danny",
195-
"name": "my-workspace",
196-
"reason": "initiated by user"
197-
}
198-
},
199-
"title": "Workspace \"my-workspace\" deleted",
200-
"body": "Hi danny\n\nYour workspace my-workspace was deleted.\nThe specified reason was \"initiated by user (danny)\"."
174+
"_version": "1.0",
175+
"msg_id": "88750cad-77d4-4663-8bc0-f46855f5019b",
176+
"payload": {
177+
"_version": "1.0",
178+
"notification_name": "Workspace Deleted",
179+
"user_id": "4ac34fcb-8155-44d5-8301-e3cd46e88b35",
180+
"user_email": "[email protected]",
181+
"user_name": "danny",
182+
"user_username": "danny",
183+
"actions": [
184+
{
185+
"label": "View workspaces",
186+
"url": "https://et23ntkhpueak.pit-1.try.coder.app/workspaces"
187+
},
188+
{
189+
"label": "View templates",
190+
"url": "https://et23ntkhpueak.pit-1.try.coder.app/templates"
191+
}
192+
],
193+
"labels": {
194+
"initiator": "danny",
195+
"name": "my-workspace",
196+
"reason": "initiated by user"
197+
}
198+
},
199+
"title": "Workspace \"my-workspace\" deleted",
200+
"body": "Hi danny\n\nYour workspace my-workspace was deleted.\nThe specified reason was \"initiated by user (danny)\"."
201201
}
202202
```
203203

0 commit comments

Comments
 (0)