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

Skip to content

Commit cec667d

Browse files
mtojekmtojek
authored
fix: prettier misses docs directory (coder#5285)
* chore: keep admin/prometheus.md if make target fails * Address PR comments * Formatted * fix: prettier misses docs * make fmt * More md files
1 parent b460358 commit cec667d

20 files changed

+143
-149
lines changed

‎ADOPTERS.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Adopters
1+
# Adopters
2+
23
[!["Join us on
34
Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache=true&logo=discord&colorB=green)](https://coder.com/chat?utm_source=github.com/coder/coder&utm_medium=github&utm_campaign=adopters.md) [![Twitter
45
Follow](https://img.shields.io/twitter/follow/coderhq?label=%40coderhq&style=social)](https://twitter.com/coderhq)
@@ -7,6 +8,6 @@ Follow](https://img.shields.io/twitter/follow/coderhq?label=%40coderhq&style=soc
78

89
> 👋 _If you are considering using Coder in your organization please introduce yourself via https://coder.com/demo_ 🙇🏻‍♂️
910
10-
| Organization | Contact | Description of Use |
11-
| --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
12-
| [Coder](https://www.coder.com) | [@coderhq](https://twitter.com/coderhq) | Coder builds coder with Coder. |
11+
| Organization | Contact | Description of Use |
12+
| ------------------------------ | --------------------------------------- | ------------------------------ |
13+
| [Coder](https://www.coder.com) | [@coderhq](https://twitter.com/coderhq) | Coder builds coder with Coder. |

‎Makefile

+3-7
Original file line numberDiff line numberDiff line change
@@ -359,9 +359,9 @@ fmt/prettier:
359359
cd site
360360
# Avoid writing files in CI to reduce file write activity
361361
ifdef CI
362-
yarn run format:check
362+
yarn run format:check . ../*.md ../docs
363363
else
364-
yarn run format:write
364+
yarn run format:write . ../*.md ../docs
365365
endif
366366
.PHONY: fmt/prettier
367367

@@ -452,11 +452,7 @@ site/src/api/typesGenerated.ts: scripts/apitypings/main.go $(shell find codersdk
452452
docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
453453
go run scripts/metricsdocgen/main.go
454454
cd site
455-
ifdef CI
456-
yarn run format:check
457-
else
458-
yarn run format:write
459-
endif
455+
yarn run format:write ../docs/admin/prometheus.md
460456

461457
update-golden-files: cli/testdata/.gen-golden
462458
.PHONY: update-golden-files

‎README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ Software development on your infrastructure. Offload your team's development fro
1111

1212
> "By leveraging Terraform, Coder lets developers run any IDE on any compute platform including on-prem, AWS, Azure, GCP, DigitalOcean, Kubernetes, Docker, and more, with workspaces running on Linux, Windows, or Mac." - **Kevin Fishner Chief of Staff at [HashiCorp](https://hashicorp.com/)**
1313
14-
1514
<p align="center">
1615
<img src="./docs/images/hero-image.png">
1716
</p>
@@ -96,7 +95,7 @@ Please file [an issue](https://github.com/coder/coder/issues/new) if any informa
9695
| [Coder](https://github.com/coder/coder) | Platform | OSS + Self-Managed | Pay your cloud | All [Terraform](https://www.terraform.io/registry/providers) resources, all clouds, multi-architecture: Linux, Mac, Windows, containers, VMs, amd64, arm64 |
9796
| [code-server](https://github.com/cdr/code-server) | Web IDE | OSS + Self-Managed | Pay your cloud | Linux, Mac, Windows, containers, VMs, amd64, arm64 |
9897
| [Coder (Classic)](https://coder.com/docs) | Platform | Self-Managed | Pay your cloud + license fees | Kubernetes Linux Containers |
99-
| [GitHub Codespaces](https://github.com/features/codespaces) | Platform | SaaS | 2x Azure Compute | Linux Virtual Machines |
98+
| [GitHub Codespaces](https://github.com/features/codespaces) | Platform | SaaS | 2x Azure Compute | Linux Virtual Machines |
10099

101100
---
102101

‎docs/CONTRIBUTING.md

+1-2
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

+1-1
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

+1-1
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

-1
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

+40-40
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

+6-6
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

0 commit comments

Comments
 (0)