enable more rules

coder · matifali · Jan 3, 2025 · Nov 25, 2024 · Nov 25, 2024 · Nov 25, 2024
commit 979a283319a8ea659c226b94b85a500c36b0ec20
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -4,12 +4,12 @@
 	"MD012": true,
 	"MD013": false,
 	"MD022": true,
-	"MD024": false,
+	"MD024": { "siblings_only": true},
 	"MD029": false,
 	"MD031": true,
 	"MD033": false,
-	"MD034": false,
-	"MD036": false,
+	"MD034": true,
+	"MD036": true,
 	"MD041": false,
 	"MD045": true,
 	"MD052": false,

diff --git a/SECURITY.md b/SECURITY.md
@@ -18,7 +18,7 @@ the community that helped make this product possible.
 
 ## Where should I report security issues?
 
-Please report security issues to security@coder.com, providing all relevant
+Please report security issues to <security@coder.com>, providing all relevant
 information. The more details you provide, the easier it will be for us to
 triage and fix the issue.
 

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/dbmock/gomock_reflect_2684282611/prog.go b/coderd/database/dbmock/gomock_reflect_2684282611/prog.go
diff --git a/codersdk/deployment.go b/codersdk/deployment.go
@@ -594,7 +594,7 @@ type ExternalAuthConfig struct {
 	// a string (e.g. coder.com) instead of by it's type.
 	//
 	// Git clone makes use of this by parsing the URL from:
-	// 'Username for "https://github.com":'
+	// 'Username for https://github.com>:'
 	// And sending it to the Coder server to match against the Regex.
 	Regex string `json:"regex" yaml:"regex"`
 	// DisplayName is shown in the UI to identify the auth config.
@@ -793,7 +793,7 @@ func DefaultSupportLinks(docsURL string) []LinkConfig {
 		},
 		{
 			Name:   "Report a bug",
-			Target: "https://github.com/coder/coder/issues/new?labels=needs+grooming&body=" + buildInfo,
+			Target: "https://github.com/coder/coder/issues/new?labels=needs+triage&body=" + buildInfo,
 			Icon:   "bug",
 		},
 		{
@@ -1174,7 +1174,7 @@ when required by your organization's security policy.`,
 			Flag:        "wildcard-access-url",
 			Env:         "CODER_WILDCARD_ACCESS_URL",
 			// Do not use a serpent.URL here. We are intentionally omitting the
-			// scheme part of the url (https://), so the standard url parsing
+			// scheme part of the url <https://>, so the standard url parsing
 			// will yield unexpected results.
 			//
 			// We have a validation function to ensure the wildcard url is correct,
@@ -1339,7 +1339,7 @@ when required by your organization's security policy.`,
 		},
 		{
 			Name:        "TLS Ciphers",
-			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.",
+			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>.",
 			Flag:        "tls-ciphers",
 			Env:         "CODER_TLS_CIPHERS",
 			Default:     "",
@@ -1350,7 +1350,7 @@ when required by your organization's security policy.`,
 		},
 		{
 			Name:        "TLS Allow Insecure Ciphers",
-			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.",
+			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>.",
 			Flag:        "tls-allow-insecure-ciphers",
 			Env:         "CODER_TLS_ALLOW_INSECURE_CIPHERS",
 			Default:     "false",
@@ -1452,7 +1452,7 @@ when required by your organization's security policy.`,
 		},
 		{
 			Name:        "DERP Config URL",
-			Description: "URL to fetch a DERP mapping on startup. See: https://tailscale.com/kb/1118/custom-derp-servers/.",
+			Description: "URL to fetch a DERP mapping on startup. See: <https://tailscale.com/kb/1118/custom-derp-servers/>.",
 			Flag:        "derp-config-url",
 			Env:         "CODER_DERP_CONFIG_URL",
 			Value:       &c.DERP.Config.URL,
@@ -1461,7 +1461,7 @@ when required by your organization's security policy.`,
 		},
 		{
 			Name:        "DERP Config Path",
-			Description: "Path to read a DERP mapping from. See: https://tailscale.com/kb/1118/custom-derp-servers/.",
+			Description: "Path to read a DERP mapping from. See: <https://tailscale.com/kb/1118/custom-derp-servers/>.",
 			Flag:        "derp-config-path",
 			Env:         "CODER_DERP_CONFIG_PATH",
 			Value:       &c.DERP.Config.Path,
@@ -1945,7 +1945,7 @@ when required by your organization's security policy.`,
 		// Trace settings
 		{
 			Name:        "Trace Enable",
-			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.",
+			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>.",
 			Flag:        "trace",
 			Env:         "CODER_TRACE_ENABLE",
 			Value:       &c.Trace.Enable,
@@ -2284,7 +2284,7 @@ when required by your organization's security policy.`,
 		},
 		{
 			Name:        "Postgres Connection URL",
-			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.",
+			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.",
 			Flag:        "postgres-url",
 			Env:         "CODER_PG_CONNECTION_URL",
 			Annotations: serpent.Annotations{}.Mark(annotationSecretKey, "true"),
@@ -2376,7 +2376,7 @@ when required by your organization's security policy.`,
 			Flag:        "agent-fallback-troubleshooting-url",
 			Env:         "CODER_AGENT_FALLBACK_TROUBLESHOOTING_URL",
 			Hidden:      true,
-			Default:     "https://coder.com/docs/templates/troubleshooting",
+			Default:     "https://coder.com/docs/admin/templates/troubleshooting",
 			Value:       &c.AgentFallbackTroubleshootingURL,
 			YAML:        "agentFallbackTroubleshootingURL",
 		},
@@ -2492,7 +2492,7 @@ when required by your organization's security policy.`,
 		},
 		{
 			Name:        "CLI Upgrade Message",
-			Description: "The upgrade message to display to users when a client/server mismatch is detected. By default it instructs users to update using 'curl -L https://coder.com/install.sh | sh'.",
+			Description: "The upgrade message to display to users when a client/server mismatch is detected. By default it instructs users to update using `curl -L https://coder.com/install.sh | sh`.",
 			Flag:        "cli-upgrade-message",
 			Env:         "CODER_CLI_UPGRADE_MESSAGE",
 			YAML:        "cliUpgradeMessage",
@@ -2530,7 +2530,7 @@ Write out the current server config as YAML to stdout.`,
 		},
 		{
 			Name:        "Custom wgtunnel Host",
-			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".`,
+			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>.",
 			Flag:        "wg-tunnel-host",
 			Env:         "WGTUNNEL_HOST",
 			YAML:        "wgtunnelHost",

diff --git a/codersdk/workspaceproxy.go b/codersdk/workspaceproxy.go
@@ -193,12 +193,12 @@ type Region struct {
 
 	// PathAppURL is the URL to the base path for path apps. Optional
 	// unless wildcard_hostname is set.
-	// E.g. https://us.example.com
+	// E.g. <https://us.example.com>
 	PathAppURL string `json:"path_app_url" table:"url"`
 
 	// WildcardHostname is the wildcard hostname for subdomain apps.
-	// E.g. *.us.example.com
-	// E.g. *--suffix.au.example.com
+	// E.g. <*.us.example.com>
+	// E.g. <*--suffix.au.example.com>
-	// E.g. <*.us.example.com>
-	// E.g. <*--suffix.au.example.com>
+	// E.g. `*.us.example.com`
+	// E.g. `*--suffix.au.example.com`
-	// E.g. <*.us.example.com>
-	// E.g. <*--suffix.au.example.com>
+	// E.g. `*.us.example.com`
+	// E.g. `*--suffix.au.example.com`
 	// Optional. Does not need to be on the same domain as PathAppURL.
 	WildcardHostname string `json:"wildcard_hostname" table:"wildcard hostname"`
 }

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -321,7 +321,7 @@ Breaking changes can be triggered in two ways:
 ### Security
 
 > If you find a vulnerability, **DO NOT FILE AN ISSUE**. Instead, send an email
-> to security@coder.com.
+> to <security@coder.com>.
 
 The
 [`security`](https://github.com/coder/coder/issues?q=sort%3Aupdated-desc+label%3Asecurity)

diff --git a/docs/admin/index.md b/docs/admin/index.md
@@ -17,7 +17,7 @@ For any information not strictly contained in these sections, check out our
 
 ## What is an image, template, dev container, or workspace
 
-**Image**
+### Image
 
 - A [base image](./templates/managing-templates/image-management.md) contains
   OS-level packages and utilities that the Coder workspace is built on. It can
@@ -26,28 +26,28 @@ For any information not strictly contained in these sections, check out our
   defined in each template.
 - Managed by: Externally to Coder.
 
-**Template**
+### Template
 
 - [Templates](./templates/index.md) include infrastructure-level dependencies
   for the workspace. For example, a template can include Kubernetes
   PersistentVolumeClaims, Docker containers, or EC2 VMs.
 - Managed by: Template administrators from within the Coder deployment.
 
-**Startup scripts**
+### Startup scripts
 
 - Agent startup scripts apply to all users of a template. This is an
   intentionally flexible area that template authors have at their disposal to
   manage the "last mile" of workspace creation.
 - Managed by: Coder template administrators.
 
-**Workspace**
+### Workspace
 
 - A [workspace](../user-guides/workspace-management.md) is the environment that
   a developer works in. Developers on a team each work from their own workspace
   and can use [multiple IDEs](../user-guides/workspace-access/index.md).
 - Managed by: Developers
 
-**Development containers (dev containers)**
+### Development containers (dev containers)
 
 - A
   [Development Container](./templates/managing-templates/devcontainers/index.md)
@@ -57,7 +57,7 @@ For any information not strictly contained in these sections, check out our
   will be built on-demand.
 - Managed by: Dev Teams
 
-**Dotfiles / personalization**
+### Dotfiles / personalization
 
 - Users may have their own specific preferences relating to shell prompt, custom
   keybindings, color schemes, and more. Users can leverage Coder's

diff --git a/docs/admin/infrastructure/scale-testing.md b/docs/admin/infrastructure/scale-testing.md
@@ -137,7 +137,7 @@ When determining scaling requirements, consider the following factors:
   connections: For a very high number of proxied connections, more memory is
   required.
 
-**HTTP API latency**
+#### HTTP API latency
 
 For a reliable Coder deployment dealing with medium to high loads, it's
 important that API calls for workspace/template queries and workspace build
@@ -152,7 +152,7 @@ between users and the load balancer. Fortunately, the latency can be improved
 with a deployment of Coder
 [workspace proxies](../networking/workspace-proxies.md).
 
-**Node Autoscaling**
+#### Node Autoscaling
 
 We recommend disabling the autoscaling for `coderd` nodes. Autoscaling can cause
 interruptions for user connections, see
@@ -186,7 +186,7 @@ When determining scaling requirements, consider the following factors:
   provisioners are free/available, the more concurrent workspace builds can be
   performed.
 
-**Node Autoscaling**
+#### Node Autoscaling
 
 Autoscaling provisioners is not an easy problem to solve unless it can be
 predicted when a number of concurrent workspace builds increases.
@@ -219,7 +219,7 @@ When determining scaling requirements, consider the following factors:
   running Coder agent and occasional CPU and memory bursts for building
   projects.
 
-**Node Autoscaling**
+#### Node Autoscaling
 
 Workspace nodes can be set to operate in autoscaling mode to mitigate the risk
 of prolonged high resource utilization.