Skip to content

Commit fe265eb

Browse files
matifalimatifali
committed
wip 2
1 parent 687b015 commit fe265eb

File tree

18 files changed

+1231
-1212
lines changed

18 files changed

+1231
-1212
lines changed

‎.markdownlint.jsonc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88

99
"MD033": false, // Inline HTML: we use it in some places
1010

11+
"MD034": false, // Bare URL: we use it in some places in generated docs see: codersdk/deployment.go
12+
1113
"MD041": false, // First line in file should be a top level heading: All of our changelogs do not start with a top level heading
1214
// TODO: We need to update /home/coder/repos/coder/coder/scripts/release/generate_release_notes.sh to generate changelogs that follow this rule
1315

‎Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -685,9 +685,15 @@ codersdk/rbacresources_gen.go: scripts/typegen/codersdk.gotmpl scripts/typegen/m
685685

686686
site/src/api/rbacresourcesGenerated.ts: scripts/typegen/codersdk.gotmpl scripts/typegen/main.go coderd/rbac/object.go coderd/rbac/policy/policy.go
687687
go run scripts/typegen/main.go rbac typescript > "$@"
688+
cd site
689+
../scripts/pnpm_install.sh
690+
pnpm exec biome format --write src/api/rbacresourcesGenerated.ts
688691

689692
site/src/api/countriesGenerated.ts: scripts/typegen/countries.tstmpl scripts/typegen/main.go codersdk/countries.go
690693
go run scripts/typegen/main.go countries > "$@"
694+
cd site
695+
../scripts/pnpm_install.sh
696+
pnpm exec biome format --write src/api/countriesGenerated.ts
691697

692698
docs/admin/integrations/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/metrics
693699
go run scripts/metricsdocgen/main.go

‎cli/testdata/coder_server_--help.golden

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ OPTIONS:
5656

5757
--postgres-url string, $CODER_PG_CONNECTION_URL
5858
URL of a PostgreSQL database. If empty, PostgreSQL binaries will be
59-
downloaded from Maven <https://repo1.maven.org/maven2> and store all
59+
downloaded from Maven https://repo1.maven.org/maven2 and store all
6060
data in the config root. Access the built-in database with "coder
6161
server postgres-builtin-url". Note that any special characters in the
6262
URL must be URL-encoded.
@@ -215,7 +215,7 @@ INTROSPECTION / TRACING OPTIONS:
215215
--trace bool, $CODER_TRACE_ENABLE
216216
Whether application tracing data is collected. It exports to a backend
217217
configured by environment variables. See:
218-
<https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md>.
218+
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
219219

220220
--trace-honeycomb-api-key string, $CODER_TRACE_HONEYCOMB_API_KEY
221221
Enables trace exporting to Honeycomb.io using the provided API Key.
@@ -269,11 +269,11 @@ backed by Tailscale and WireGuard.
269269

270270
--derp-config-path string, $CODER_DERP_CONFIG_PATH
271271
Path to read a DERP mapping from. See:
272-
<https://tailscale.com/kb/1118/custom-derp-servers/>.
272+
https://tailscale.com/kb/1118/custom-derp-servers/.
273273

274274
--derp-config-url string, $CODER_DERP_CONFIG_URL
275275
URL to fetch a DERP mapping on startup. See:
276-
<https://tailscale.com/kb/1118/custom-derp-servers/>.
276+
https://tailscale.com/kb/1118/custom-derp-servers/.
277277

278278
--derp-force-websockets bool, $CODER_DERP_FORCE_WEBSOCKETS
279279
Force clients and agents to always use WebSocket to connect to DERP
@@ -355,7 +355,7 @@ can safely ignore these settings.
355355
--tls-allow-insecure-ciphers bool, $CODER_TLS_ALLOW_INSECURE_CIPHERS (default: false)
356356
By default, only ciphers marked as 'secure' are allowed to be used.
357357
See
358-
<https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95>.
358+
https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95.
359359

360360
--tls-cert-file string-array, $CODER_TLS_CERT_FILE
361361
Path to each certificate for TLS. It requires a PEM-encoded file. To
@@ -365,7 +365,7 @@ can safely ignore these settings.
365365

366366
--tls-ciphers string-array, $CODER_TLS_CIPHERS
367367
Specify specific TLS ciphers that allowed to be used. See
368-
<https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75>.
368+
https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75.
369369

370370
--tls-client-auth string, $CODER_TLS_CLIENT_AUTH (default: none)
371371
Policy the server will follow for TLS Client Authentication. Accepted

‎cli/testdata/server-config.yaml.golden

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ networking:
9090
# (default: <unset>, type: string)
9191
clientKeyFile: ""
9292
# Specify specific TLS ciphers that allowed to be used. See
93-
# <https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75>.
93+
# https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75.
9494
# (default: <unset>, type: string-array)
9595
tlsCiphers: []
9696
# By default, only ciphers marked as 'secure' are allowed to be used. See
97-
# <https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95>.
97+
# https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95.
9898
# (default: false, type: bool)
9999
tlsAllowInsecureCiphers: false
100100
# Controls if the 'Strict-Transport-Security' header is set on all static file
@@ -157,11 +157,11 @@ networking:
157157
# (default: <unset>, type: bool)
158158
forceWebSockets: false
159159
# URL to fetch a DERP mapping on startup. See:
160-
# <https://tailscale.com/kb/1118/custom-derp-servers/>.
160+
# https://tailscale.com/kb/1118/custom-derp-servers/.
161161
# (default: <unset>, type: string)
162162
url: ""
163163
# Path to read a DERP mapping from. See:
164-
# <https://tailscale.com/kb/1118/custom-derp-servers/>.
164+
# https://tailscale.com/kb/1118/custom-derp-servers/.
165165
# (default: <unset>, type: string)
166166
configPath: ""
167167
# Headers to trust for forwarding IP addresses. e.g. Cf-Connecting-Ip,
@@ -217,7 +217,7 @@ introspection:
217217
tracing:
218218
# Whether application tracing data is collected. It exports to a backend
219219
# configured by environment variables. See:
220-
# <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md>.
220+
# https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.
221221
# (default: <unset>, type: bool)
222222
enable: false
223223
# Enables capturing of logs as events in traces. This is useful for debugging, but
@@ -499,9 +499,9 @@ supportLinks: []
499499
# External Authentication providers.
500500
# (default: <unset>, type: struct[[]codersdk.ExternalAuthConfig])
501501
externalAuthProviders: []
502-
# Hostname of HTTPS server that runs <https://github.com/coder/wgtunnel>. By
502+
# Hostname of HTTPS server that runs https://github.com/coder/wgtunnel. By
503503
# default, this will pick the best available wgtunnel server hosted by Coder. e.g.
504-
# <tunnel.example.com>.
504+
# tunnel.example.com.
505505
# (default: <unset>, type: string)
506506
wgtunnelHost: ""
507507
# Allow users to set quiet hours schedules each day for workspaces to avoid

‎coderd/apidoc/docs.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎coderd/apidoc/swagger.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎codersdk/deployment.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ type ExternalAuthConfig struct {
594594
// a string (e.g. coder.com) instead of by it's type.
595595
//
596596
// Git clone makes use of this by parsing the URL from:
597-
// 'Username for <https://github.com>:'
597+
// 'Username for https://github.com:'
598598
// And sending it to the Coder server to match against the Regex.
599599
Regex string `json:"regex" yaml:"regex"`
600600
// DisplayName is shown in the UI to identify the auth config.
@@ -1174,7 +1174,7 @@ when required by your organization's security policy.`,
11741174
Flag: "wildcard-access-url",
11751175
Env: "CODER_WILDCARD_ACCESS_URL",
11761176
// Do not use a serpent.URL here. We are intentionally omitting the
1177-
// scheme part of the url <https://>, so the standard url parsing
1177+
// scheme part of the url https://, so the standard url parsing
11781178
// will yield unexpected results.
11791179
//
11801180
// We have a validation function to ensure the wildcard url is correct,
@@ -1339,7 +1339,7 @@ when required by your organization's security policy.`,
13391339
},
13401340
{
13411341
Name: "TLS Ciphers",
1342-
Description: "Specify specific TLS ciphers that allowed to be used. See <https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75>.",
1342+
Description: "Specify specific TLS ciphers that allowed to be used. See https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L53-L75.",
13431343
Flag: "tls-ciphers",
13441344
Env: "CODER_TLS_CIPHERS",
13451345
Default: "",
@@ -1350,7 +1350,7 @@ when required by your organization's security policy.`,
13501350
},
13511351
{
13521352
Name: "TLS Allow Insecure Ciphers",
1353-
Description: "By default, only ciphers marked as 'secure' are allowed to be used. See <https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95>.",
1353+
Description: "By default, only ciphers marked as 'secure' are allowed to be used. See https://github.com/golang/go/blob/master/src/crypto/tls/cipher_suites.go#L82-L95.",
13541354
Flag: "tls-allow-insecure-ciphers",
13551355
Env: "CODER_TLS_ALLOW_INSECURE_CIPHERS",
13561356
Default: "false",
@@ -1452,7 +1452,7 @@ when required by your organization's security policy.`,
14521452
},
14531453
{
14541454
Name: "DERP Config URL",
1455-
Description: "URL to fetch a DERP mapping on startup. See: <https://tailscale.com/kb/1118/custom-derp-servers/>.",
1455+
Description: "URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/.",
14561456
Flag: "derp-config-url",
14571457
Env: "CODER_DERP_CONFIG_URL",
14581458
Value: &c.DERP.Config.URL,
@@ -1461,7 +1461,7 @@ when required by your organization's security policy.`,
14611461
},
14621462
{
14631463
Name: "DERP Config Path",
1464-
Description: "Path to read a DERP mapping from. See: <https://tailscale.com/kb/1118/custom-derp-servers/>.",
1464+
Description: "Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/.",
14651465
Flag: "derp-config-path",
14661466
Env: "CODER_DERP_CONFIG_PATH",
14671467
Value: &c.DERP.Config.Path,
@@ -1945,7 +1945,7 @@ when required by your organization's security policy.`,
19451945
// Trace settings
19461946
{
19471947
Name: "Trace Enable",
1948-
Description: "Whether application tracing data is collected. It exports to a backend configured by environment variables. See: <https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md>.",
1948+
Description: "Whether application tracing data is collected. It exports to a backend configured by environment variables. See: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md.",
19491949
Flag: "trace",
19501950
Env: "CODER_TRACE_ENABLE",
19511951
Value: &c.Trace.Enable,
@@ -2284,7 +2284,7 @@ when required by your organization's security policy.`,
22842284
},
22852285
{
22862286
Name: "Postgres Connection URL",
2287-
Description: "URL of a PostgreSQL database. If empty, PostgreSQL binaries will be downloaded from Maven <https://repo1.maven.org/maven2> and store all data in the config root. Access the built-in database with \"coder server postgres-builtin-url\". Note that any special characters in the URL must be URL-encoded.",
2287+
Description: "URL of a PostgreSQL database. If empty, PostgreSQL binaries will be downloaded from Maven https://repo1.maven.org/maven2 and store all data in the config root. Access the built-in database with \"coder server postgres-builtin-url\". Note that any special characters in the URL must be URL-encoded.",
22882288
Flag: "postgres-url",
22892289
Env: "CODER_PG_CONNECTION_URL",
22902290
Annotations: serpent.Annotations{}.Mark(annotationSecretKey, "true"),
@@ -2530,7 +2530,7 @@ Write out the current server config as YAML to stdout.`,
25302530
},
25312531
{
25322532
Name: "Custom wgtunnel Host",
2533-
Description: "Hostname of HTTPS server that runs <https://github.com/coder/wgtunnel>. By default, this will pick the best available wgtunnel server hosted by Coder. e.g. <tunnel.example.com>.",
2533+
Description: "Hostname of HTTPS server that runs https://github.com/coder/wgtunnel. By default, this will pick the best available wgtunnel server hosted by Coder. e.g. tunnel.example.com.",
25342534
Flag: "wg-tunnel-host",
25352535
Env: "WGTUNNEL_HOST",
25362536
YAML: "wgtunnelHost",

‎docs/reference/api/schemas.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/reference/cli/server.md

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

‎docs/reference/cli/templates_create.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy