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

Skip to content

Commit 2e70ad5

Browse files
committed
make fmt
1 parent ef6de5d commit 2e70ad5

File tree

10 files changed

+28
-31
lines changed

10 files changed

+28
-31
lines changed

docs/admin/external-auth.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,8 +184,7 @@ CODER_EXTERNAL_AUTH_0_REGEX=github\.company\.org
184184
185185
### JFrog Artifactory
186186

187-
See
188-
[this](https://coder.com/docs/guides/artifactory-integration#jfrog-oauth)
187+
See [this](https://coder.com/docs/guides/artifactory-integration#jfrog-oauth)
189188
guide on instructions on how to set up for JFrog Artifactory.
190189

191190
### Custom scopes

docs/architecture/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,8 +357,8 @@ project-oriented [features](https://containers.dev/features) without requiring
357357
platform administrators to push altered Docker images.
358358

359359
Learn more about
360-
[Dev containers support](https://coder.com/docs/templates/dev-containers)
361-
in Coder.
360+
[Dev containers support](https://coder.com/docs/templates/dev-containers) in
361+
Coder.
362362

363363
![Architecture Diagram](../images/architecture-devcontainers.png)
364364

docs/faqs.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ to establish these direct connections.
5252
Setting the following flags as shown disables this logic to simplify
5353
troubleshooting.
5454

55-
| Flag | Value | Meaning |
56-
| -------------------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
55+
| Flag | Value | Meaning |
56+
| ---------------------------------------------------------------------------------------------------- | ----------- | ------------------------------------- |
5757
| [`CODER_BLOCK_DIRECT`](https://coder.com/docs/cli/server#--block-direct-connections) | `true` | Blocks direct connections |
5858
| [`CODER_DERP_SERVER_STUN_ADDRESSES`](https://coder.com/docs/cli/server#--derp-server-stun-addresses) | `"disable"` | Disables STUN |
5959
| [`CODER_DERP_FORCE_WEBSOCKETS`](https://coder.com/docs/cli/server#--derp-force-websockets) | `true` | Forces websockets over Tailscale DERP |
@@ -118,8 +118,7 @@ resource "coder_app" "code-server" {
118118
An important concept to understand is that Coder creates workspaces which have
119119
an agent that must be able to reach the `coder server`.
120120

121-
If the
122-
[`CODER_ACCESS_URL`](https://coder.com/docs/admin/configure#access-url)
121+
If the [`CODER_ACCESS_URL`](https://coder.com/docs/admin/configure#access-url)
123122
is not accessible from a workspace, the workspace may build, but the agent
124123
cannot reach Coder, and thus the missing icons. e.g., Terminal, IDEs, Apps.
125124

@@ -149,9 +148,9 @@ of these values can lead to existing workspaces failing to start. This issue
149148
occurs because the Terraform state will not be in sync with the new template.
150149

151150
However, a lesser-known CLI sub-command,
152-
[`coder update`](https://coder.com/docs/cli/update), can resolve this
153-
issue. This command re-prompts users to re-enter the input variables,
154-
potentially saving the workspace from a failed status.
151+
[`coder update`](https://coder.com/docs/cli/update), can resolve this issue.
152+
This command re-prompts users to re-enter the input variables, potentially
153+
saving the workspace from a failed status.
155154

156155
```sh
157156
coder update --always-prompt <workspace name>

docs/guides/artifactory-integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ two type of modules that automate the JFrog Artifactory and Coder integration.
3737

3838
This module is usable by JFrog self-hosted (on-premises) Artifactory as it
3939
requires configuring a custom integration. This integration benefits from
40-
Coder's [external-auth](https://coder.com/docs/admin/external-auth)
41-
feature and allows each user to authenticate with Artifactory using an OAuth
42-
flow and issues user-scoped tokens to each user.
40+
Coder's [external-auth](https://coder.com/docs/admin/external-auth) feature and
41+
allows each user to authenticate with Artifactory using an OAuth flow and issues
42+
user-scoped tokens to each user.
4343

4444
To set this up, follow these steps:
4545

@@ -72,8 +72,8 @@ artifactory:
7272
![JFrog Platform new integration](../images/guides/artifactory-integration/jfrog-oauth-app.png)
7373

7474
3. Add a new
75-
[external authentication](https://coder.com/docs/admin/external-auth)
76-
to Coder by setting these env variables,
75+
[external authentication](https://coder.com/docs/admin/external-auth) to
76+
Coder by setting these env variables,
7777

7878
```env
7979
# JFrog Artifactory External Auth

docs/guides/configuring-okta.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ be sent.
3939

4040
> !! If the user does not belong to any groups, the claim will not be sent. Make
4141
> sure the user authenticating for testing is in at least 1 group. Defer to
42-
> [troubleshooting](https://coder.com/docs/admin/auth#troubleshooting)
43-
> with issues
42+
> [troubleshooting](https://coder.com/docs/admin/auth#troubleshooting) with
43+
> issues
4444
4545
![Okta OpenID Connect ID Token](../images/guides/okta/oidc_id_token.png)
4646

docs/guides/example-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ December 13, 2023
1111
---
1212

1313
This is a guide on how to make Coder guides, it is not listed on our
14-
[official guides page](https://coder.com/docs/guides) in the docs.
15-
Intended for those who don't frequently contribute documentation changes to the
16-
`coder/coder` repository.
14+
[official guides page](https://coder.com/docs/guides) in the docs. Intended for
15+
those who don't frequently contribute documentation changes to the `coder/coder`
16+
repository.
1717

1818
## Content
1919

docs/guides/xray-integration.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,8 @@ using Coder's [JFrog Xray Integration](https://github.com/coder/coder-xray).
2727
[permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
2828
for the repositories you want to scan.
2929
2. Create a Coder
30-
[token](https://coder.com/docs/cli/tokens_create#tokens-create)
31-
with a user that has the
32-
[`owner`](https://coder.com/docs/admin/users#roles) role.
30+
[token](https://coder.com/docs/cli/tokens_create#tokens-create) with a user
31+
that has the [`owner`](https://coder.com/docs/admin/users#roles) role.
3332
3. Create kubernetes secrets for the JFrog Xray and Coder tokens.
3433

3534
```bash

docs/install/1-click.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Coder can be installed on many cloud providers using our
33

44
| Platform Name | Status | Documentation | Deploy |
55
| --------------------- | ----------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
6-
| AWS EC2 | Live ✅ | [Guide: AWS](https://coder.com/docs/platforms/aws) | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) |
7-
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
8-
| Google Compute Engine | Live ✅ | [Guide: Google Compute Engine](https://coder.com/docs/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) |
6+
| AWS EC2 | Live ✅ | [Guide: AWS](https://coder.com/docs/platforms/aws) | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa) |
7+
| AWS EKS | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/install/kubernetes) | [Deploy from AWS Marketplace](https://example.com) |
8+
| Google Compute Engine | Live ✅ | [Guide: Google Compute Engine](https://coder.com/docs/platforms/gcp) | [Deploy from GCP Marketplace](https://console.cloud.google.com/marketplace/product/coder-enterprise-market-public/coder-v2) |
99
| Fly.io | Live ✅ | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) | [Deploy Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io) |
1010
| Railway.app | Live ✅ | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app) | [![Deploy Coder on Railway](https://railway.app/button.svg)](https://railway.app/template/coder?referralCode=tfH8Uw) |
1111
| Heroku | Live ✅ | [Docs: Deploy Coder on Heroku](https://github.com/coder/packages/blob/main/heroku/README.md) | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) |

docs/security/0001_user_apikeys_invalidation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,6 @@ Otherwise, the following information will be reported:
8282
- Time the affected API key was last used
8383

8484
> 💡 If your license includes the
85-
> [Audit Logs](https://coder.com/docs/admin/audit-logs#filtering-logs)
86-
> feature, you can then query all actions performed by the above users by using
87-
> the filter `email:$USER_EMAIL`.
85+
> [Audit Logs](https://coder.com/docs/admin/audit-logs#filtering-logs) feature,
86+
> you can then query all actions performed by the above users by using the
87+
> filter `email:$USER_EMAIL`.

examples/templates/envbox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The following environment variables can be used to configure various aspects of
2323
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
2424
| `CODER_INNER_IMAGE` | The image to use for the inner container. | True |
2525
| `CODER_INNER_USERNAME` | The username to use for the inner container. | True |
26-
| `CODER_AGENT_TOKEN` | The [Coder Agent](https://coder.com/docs/about/architecture#agents) token to pass to the inner container. | True |
26+
| `CODER_AGENT_TOKEN` | The [Coder Agent](https://coder.com/docs/about/architecture#agents) token to pass to the inner container. | True |
2727
| `CODER_INNER_ENVS` | The environment variables to pass to the inner container. A wildcard can be used to match a prefix. Ex: `CODER_INNER_ENVS=KUBERNETES_*,MY_ENV,MY_OTHER_ENV` | false |
2828
| `CODER_INNER_HOSTNAME` | The hostname to use for the inner container. | false |
2929
| `CODER_IMAGE_PULL_SECRET` | The docker credentials to use when pulling the inner container. The recommended way to do this is to create an [Image Pull Secret](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/#registry-secret-existing-credentials) and then reference the secret using an [environment variable](https://kubernetes.io/docs/tasks/inject-data-application/distribute-credentials-secure/#define-container-environment-variables-using-secret-data). | false |

0 commit comments

Comments
 (0)