Skip to content

Commit 36e1041

Browse files
mtojekmtojek
committed
make fmt
1 parent 6e53628 commit 36e1041

File tree

17 files changed

+134
-136
lines changed

17 files changed

+134
-136
lines changed

‎docs/CONTRIBUTING.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ direnv: export +AR +AS +CC +CONFIG_SHELL +CXX +HOST_PATH +IN_NIX_SHELL +LD +NIX_
3939
```
4040

4141
Alternatively if you do not want to use nix then you'll need to install the need the following tools by hand:
42+
4243
- Go 1.18+
4344
- on macOS, run `brew install go`
4445
- Node 14+
@@ -63,7 +64,6 @@ Alternatively if you do not want to use nix then you'll need to install the need
6364
- [`pandoc`]()
6465
- on macOS, run `brew install pandocomatic`
6566

66-
6767
### Development workflow
6868

6969
Use the following `make` commands and scripts in development:
@@ -143,7 +143,6 @@ $ git ls-files v0.12.2 -- coderd/database/migrations/*.up.sql
143143

144144
This helps in naming the dump (e.g. `000069` above).
145145

146-
147146
## Styling
148147

149148
### Documentation

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ Azure, Google Cloud, Kubernetes, and more.
9292
- Coder is not a SaaS/fully-managed offering. You must host
9393
Coder on a cloud service (AWS, Azure, GCP) or your private data center.
9494

95-
9695
## Up next
96+
9797
- Learn about [Templates](./templates.md)

‎docs/admin/git-providers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Coder integrates with git providers so developers can authenticate with reposito
44

55
## How it works
66

7-
When developers use `git` inside their workspace, they are first prompted to authenticate. After that, Coder will store/refresh tokens for future operations.
7+
When developers use `git` inside their workspace, they are first prompted to authenticate. After that, Coder will store/refresh tokens for future operations.
88

99
<video autoplay playsinline loop>
1010
<source src="https://github.com/coder/coder/blob/main/site/static/gitauth.mp4?raw=true" type="video/mp4">

‎docs/admin/groups.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,3 @@ Groups can be used with [template RBAC](./rbac.md) to give groups of users acces
77
## Enabling this feature
88

99
This feature is only available with an enterprise license. [Learn more](../enterprise.md)
10-

‎docs/admin/prometheus.md‎

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -29,45 +29,45 @@ The environment variable `CODER_PROMETHEUS_ENABLE` will be enabled automatically
2929

3030
<!-- Code generated by 'make docs/admin/prometheus.md'. DO NOT EDIT -->
3131

32-
| Name | Type | Description | Labels |
33-
| - | - | - | - |
34-
| `coderd_api_active_users_duration_hour` | gauge | The number of users that have been active within the last hour. | |
35-
| `coderd_api_concurrent_requests` | gauge | The number of concurrent API requests | |
36-
| `coderd_api_concurrent_websockets` | gauge | The total number of concurrent API websockets | |
37-
| `coderd_api_request_latencies_ms` | histogram | Latency distribution of requests in milliseconds | `method` `path` |
38-
| `coderd_api_requests_processed_total` | counter | The total number of processed API requests | `code` `method` `path` |
39-
| `coderd_api_websocket_durations_ms` | histogram | Websocket duration distribution of requests in milliseconds | `path` |
40-
| `coderd_api_workspace_latest_build_total` | gauge | The latest workspace builds with a status. | `status` |
41-
| `coderd_provisionerd_job_timings_ms` | histogram | The provisioner job time duration. | `provisioner` `status` |
42-
| `coderd_provisionerd_jobs_current` | gauge | The number of currently running provisioner jobs. | `provisioner` |
43-
| `go_gc_duration_seconds` | summary | A summary of the pause duration of garbage collection cycles. | |
44-
| `go_goroutines` | gauge | Number of goroutines that currently exist. | |
45-
| `go_info` | gauge | Information about the Go environment. | `version` |
46-
| `go_memstats_alloc_bytes` | gauge | Number of bytes allocated and still in use. | |
47-
| `go_memstats_alloc_bytes_total` | counter | Total number of bytes allocated, even if freed. | |
48-
| `go_memstats_buck_hash_sys_bytes` | gauge | Number of bytes used by the profiling bucket hash table. | |
49-
| `go_memstats_frees_total` | counter | Total number of frees. | |
50-
| `go_memstats_gc_sys_bytes` | gauge | Number of bytes used for garbage collection system metadata. | |
51-
| `go_memstats_heap_alloc_bytes` | gauge | Number of heap bytes allocated and still in use. | |
52-
| `go_memstats_heap_idle_bytes` | gauge | Number of heap bytes waiting to be used. | |
53-
| `go_memstats_heap_inuse_bytes` | gauge | Number of heap bytes that are in use. | |
54-
| `go_memstats_heap_objects` | gauge | Number of allocated objects. | |
55-
| `go_memstats_heap_released_bytes` | gauge | Number of heap bytes released to OS. | |
56-
| `go_memstats_heap_sys_bytes` | gauge | Number of heap bytes obtained from system. | |
57-
| `go_memstats_last_gc_time_seconds` | gauge | Number of seconds since 1970 of last garbage collection. | |
58-
| `go_memstats_lookups_total` | counter | Total number of pointer lookups. | |
59-
| `go_memstats_mallocs_total` | counter | Total number of mallocs. | |
60-
| `go_memstats_mcache_inuse_bytes` | gauge | Number of bytes in use by mcache structures. | |
61-
| `go_memstats_mcache_sys_bytes` | gauge | Number of bytes used for mcache structures obtained from system. | |
62-
| `go_memstats_mspan_inuse_bytes` | gauge | Number of bytes in use by mspan structures. | |
63-
| `go_memstats_mspan_sys_bytes` | gauge | Number of bytes used for mspan structures obtained from system. | |
64-
| `go_memstats_next_gc_bytes` | gauge | Number of heap bytes when next garbage collection will take place. | |
65-
| `go_memstats_other_sys_bytes` | gauge | Number of bytes used for other system allocations. | |
66-
| `go_memstats_stack_inuse_bytes` | gauge | Number of bytes in use by the stack allocator. | |
67-
| `go_memstats_stack_sys_bytes` | gauge | Number of bytes obtained from system for stack allocator. | |
68-
| `go_memstats_sys_bytes` | gauge | Number of bytes obtained from system. | |
69-
| `go_threads` | gauge | Number of OS threads created. | |
70-
| `promhttp_metric_handler_requests_in_flight` | gauge | Current number of scrapes being served. | |
71-
| `promhttp_metric_handler_requests_total` | counter | Total number of scrapes by HTTP status code. | `code` |
32+
| Name | Type | Description | Labels |
33+
| -------------------------------------------- | --------- | ------------------------------------------------------------------ | ---------------------- |
34+
| `coderd_api_active_users_duration_hour` | gauge | The number of users that have been active within the last hour. | |
35+
| `coderd_api_concurrent_requests` | gauge | The number of concurrent API requests | |
36+
| `coderd_api_concurrent_websockets` | gauge | The total number of concurrent API websockets | |
37+
| `coderd_api_request_latencies_ms` | histogram | Latency distribution of requests in milliseconds | `method` `path` |
38+
| `coderd_api_requests_processed_total` | counter | The total number of processed API requests | `code` `method` `path` |
39+
| `coderd_api_websocket_durations_ms` | histogram | Websocket duration distribution of requests in milliseconds | `path` |
40+
| `coderd_api_workspace_latest_build_total` | gauge | The latest workspace builds with a status. | `status` |
41+
| `coderd_provisionerd_job_timings_ms` | histogram | The provisioner job time duration. | `provisioner` `status` |
42+
| `coderd_provisionerd_jobs_current` | gauge | The number of currently running provisioner jobs. | `provisioner` |
43+
| `go_gc_duration_seconds` | summary | A summary of the pause duration of garbage collection cycles. | |
44+
| `go_goroutines` | gauge | Number of goroutines that currently exist. | |
45+
| `go_info` | gauge | Information about the Go environment. | `version` |
46+
| `go_memstats_alloc_bytes` | gauge | Number of bytes allocated and still in use. | |
47+
| `go_memstats_alloc_bytes_total` | counter | Total number of bytes allocated, even if freed. | |
48+
| `go_memstats_buck_hash_sys_bytes` | gauge | Number of bytes used by the profiling bucket hash table. | |
49+
| `go_memstats_frees_total` | counter | Total number of frees. | |
50+
| `go_memstats_gc_sys_bytes` | gauge | Number of bytes used for garbage collection system metadata. | |
51+
| `go_memstats_heap_alloc_bytes` | gauge | Number of heap bytes allocated and still in use. | |
52+
| `go_memstats_heap_idle_bytes` | gauge | Number of heap bytes waiting to be used. | |
53+
| `go_memstats_heap_inuse_bytes` | gauge | Number of heap bytes that are in use. | |
54+
| `go_memstats_heap_objects` | gauge | Number of allocated objects. | |
55+
| `go_memstats_heap_released_bytes` | gauge | Number of heap bytes released to OS. | |
56+
| `go_memstats_heap_sys_bytes` | gauge | Number of heap bytes obtained from system. | |
57+
| `go_memstats_last_gc_time_seconds` | gauge | Number of seconds since 1970 of last garbage collection. | |
58+
| `go_memstats_lookups_total` | counter | Total number of pointer lookups. | |
59+
| `go_memstats_mallocs_total` | counter | Total number of mallocs. | |
60+
| `go_memstats_mcache_inuse_bytes` | gauge | Number of bytes in use by mcache structures. | |
61+
| `go_memstats_mcache_sys_bytes` | gauge | Number of bytes used for mcache structures obtained from system. | |
62+
| `go_memstats_mspan_inuse_bytes` | gauge | Number of bytes in use by mspan structures. | |
63+
| `go_memstats_mspan_sys_bytes` | gauge | Number of bytes used for mspan structures obtained from system. | |
64+
| `go_memstats_next_gc_bytes` | gauge | Number of heap bytes when next garbage collection will take place. | |
65+
| `go_memstats_other_sys_bytes` | gauge | Number of bytes used for other system allocations. | |
66+
| `go_memstats_stack_inuse_bytes` | gauge | Number of bytes in use by the stack allocator. | |
67+
| `go_memstats_stack_sys_bytes` | gauge | Number of bytes obtained from system for stack allocator. | |
68+
| `go_memstats_sys_bytes` | gauge | Number of bytes obtained from system. | |
69+
| `go_threads` | gauge | Number of OS threads created. | |
70+
| `promhttp_metric_handler_requests_in_flight` | gauge | Current number of scrapes being served. | |
71+
| `promhttp_metric_handler_requests_total` | counter | Total number of scrapes by HTTP status code. | `code` |
7272

7373
<!-- End generated by 'make docs/admin/prometheus.md'. -->

‎docs/admin/quotas.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ templates and assigning budgets to users. Users that exceed their budget will be
55
blocked from launching more workspaces until they either delete their other workspaces
66
or get their budget extended.
77

8-
For example: A template is configured with a cost of 5 credits per day, and the user is
8+
For example: A template is configured with a cost of 5 credits per day, and the user is
99
granted a budget of 15 credits per day. This budget limits the user to 3 concurrent workspaces.
1010

1111
Quotas are licensed with [Groups](./groups.md).
@@ -48,18 +48,18 @@ resource "docker_container" "workspace" {
4848
}
4949
5050
resource "coder_metadata" "workspace" {
51-
count = data.coder_workspace.me.start_count
51+
count = data.coder_workspace.me.start_count
5252
resource_id = docker_container.workspace.id
5353
daily_cost = 20
5454
}
5555
```
5656

57-
When the workspace above is shut down, the `docker_container` and
57+
When the workspace above is shut down, the `docker_container` and
5858
`coder_metadata` both get deleted. This reduces the cost from 30 credits to
59-
10 credits.
59+
10 credits.
6060

61-
Resources without a `daily_cost` value are considered to cost 0. If the cost
62-
was removed on the `docker_volume` above, the template would consume 0 credits when
61+
Resources without a `daily_cost` value are considered to cost 0. If the cost
62+
was removed on the `docker_volume` above, the template would consume 0 credits when
6363
it's offline. This technique is good for incentivizing users to shut down their
6464
unused workspaces and freeing up compute in the cluster.
6565

‎docs/admin/telemetry.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ First of all, we do not collect any information that could threaten the security
88

99
You can find a full list of the data we collect in the source code [here](https://github.com/coder/coder/blob/main/coderd/telemetry/telemetry.go).
1010

11-
Telemetry can be configured with the `CODER_TELEMETRY=x` environment variable.
11+
Telemetry can be configured with the `CODER_TELEMETRY=x` environment variable.
1212

1313
For example, telemetry can be disabled with `CODER_TELEMETRY=false`.
1414

‎docs/contributing/documentation.md‎

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
# Documentation
2-
3-
This style guide is primarily for use with authoring documentation.
1+
# Documentation
42

3+
This style guide is primarily for use with authoring documentation.
54

65
## General guidelines
76

87
- Use sentence case, even in titles (do not punctuate the title, though)
98
- Use the second person
109
- Use the active voice
11-
- Use plural nouns and pronouns (*they*, *their*, or *them*), especially when
10+
- Use plural nouns and pronouns (_they_, _their_, or _them_), especially when
1211
the specific number is uncertain (i.e., "Set up your environments" even though
1312
you don't know if the user will have one or many environments)
1413
- When writing documentation titles, use the noun form, not the gerund form (e.g., "Environment
@@ -17,19 +16,19 @@ This style guide is primarily for use with authoring documentation.
1716
example, ["A Job creates one or more
1817
Pods..."](https://kubernetes.io/docs/concepts/workloads/controllers/job/) is
1918
correct when writing about Kubernetes. However, in other contexts, neither
20-
*job* nor *pods* would be capitalized. Please follow the conventions set forth
19+
_job_ nor _pods_ would be capitalized. Please follow the conventions set forth
2120
by the relevant companies and open source communities.
2221

2322
## Third-party references
2423

2524
If you have questions that aren't explicitly covered by this guide, consult the
2625
following third-party references:
2726

28-
| **Type of guidance** | **Third-party reference** |
29-
| - | - |
30-
| Spelling | [Merriam-Webster.com](https://www.merriam-webster.com/) |
31-
| Style - nontechnical | [The Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html) |
32-
| Style - technical | [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) |
27+
| **Type of guidance** | **Third-party reference** |
28+
| -------------------- | -------------------------------------------------------------------------------------- |
29+
| Spelling | [Merriam-Webster.com](https://www.merriam-webster.com/) |
30+
| Style - nontechnical | [The Chicago Manual of Style](https://www.chicagomanualofstyle.org/home.html) |
31+
| Style - technical | [Microsoft Writing Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/) |
3332

3433
## Tools
3534

@@ -50,14 +49,14 @@ Use **bold** formatting when referring to UI elements.
5049

5150
### Italics
5251

53-
Use *italics* for:
52+
Use _italics_ for:
5453

5554
- Parameter names
5655
- Mathematical and version variables
5756

5857
### Code font
5958

60-
Use *code font* for:
59+
Use _code font_ for:
6160

6261
- User text input
6362
- Command-line utility names
@@ -68,7 +67,7 @@ Use *code font* for:
6867
- HTTP verbs, status codes, and content-type values
6968
- Placeholder variables
7069

71-
Use *code blocks* for code samples and other blocks of code. Be sure to indicate
70+
Use _code blocks_ for code samples and other blocks of code. Be sure to indicate
7271
the language your using to apply the proper syntax highlighting.
7372

7473
```text
@@ -80,10 +79,10 @@ For code that you want users to enter via a command-line interface, use
8079

8180
### Punctuation
8281

83-
Do not use the ampersand (&) as a shorthand for *and* unless you're referring to a
84-
UI element or the name of something that uses *&*.
82+
Do not use the ampersand (&) as a shorthand for _and_ unless you're referring to a
83+
UI element or the name of something that uses _&_.
8584

86-
You can use the symbol `~` in place of the word *approximately*.
85+
You can use the symbol `~` in place of the word _approximately_.
8786

8887
### UI elements
8988

@@ -147,4 +146,3 @@ We also do not capitalize the names of user roles:
147146
## Standardized spellings
148147

149148
- WiFi
150-

‎docs/dotfiles.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Dotfiles
22

33
<!-- markdown-link-check-disable -->
4+
45
Coder offers the `coder dotfiles <repo>` command which simplifies workspace
56
personalization. Our behavior is consistent with Codespaces, so
67
[their documentation](https://docs.github.com/en/codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account#dotfiles)
78
explains how it loads your repo.
9+
810
<!-- markdown-link-check-enable -->
911

1012
You can read more on dotfiles best practices [here](https://dotfiles.github.io).

‎docs/enterprise.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,18 @@ Coder is free to use and includes some features that are only accessible with a
44
Contact sales@coder.com to obtain a license.
55

66
### User Management
7+
78
- [Groups](./admin/groups.md)
89
- [Template RBAC](./admin/rbac.md)
910
- [SCIM](./admin/auth.md#scim)
1011

1112
### Networking & Deployment
13+
1214
- [High Availability](./admin/high-availability.md)
1315
- [Browser Only Connections](./networking.md#browser-only-connections)
1416

1517
### Other
18+
1619
- [Audit Logging](./admin/audit-logs.md)
1720
- [Quotas](./admin/quotas.md)
1821

0 commit comments

Comments
 (0)