Skip to content

Commit b5b2e91

Browse files
committed
use new linter
1 parent c6d7b3b commit b5b2e91

File tree

5 files changed

+39
-93
lines changed

5 files changed

+39
-93
lines changed

docs/admin/integrations/island.md

Lines changed: 25 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ April 24, 2024
1010

1111
---
1212

13-
[Island][] is an enterprise-grade browser, offering a Chromium-based experience
13+
[Island](https://www.island.io/) is an enterprise-grade browser, offering a Chromium-based experience
1414
similar to popular web browsers like Chrome and Edge. It includes built-in
1515
security features for corporate applications and data, aiming to bridge the gap
1616
between consumer-focused browsers and the security needs of the enterprise.
1717

18-
Coder natively integrates with Island’s feature set, which include data
18+
Coder natively integrates with Island's feature set, which include data
1919
loss protection (DLP), application awareness, browser session recording, and
2020
single sign-on (SSO). This guide intends to document these feature categories
2121
and how they apply to your Coder deployment.
@@ -28,18 +28,18 @@ We recommend creating an Application Group specific to Coder in the Island
2828
Management console. This Application Group object will be referenced when
2929
creating browser policies.
3030

31-
[See the Island documentation for creating an Application Group][app-group].
31+
[See the Island documentation for creating an Application Group](https://documentation.island.io/docs/create-and-configure-an-application-group-object).
3232

3333
## Advanced Data Loss Protection
3434

35-
Integrate Island’s advanced data loss prevention (DLP) capabilities with
36-
Coder’s cloud development environment (CDE), enabling you to control the
37-
“last mile” between developers’ CDE and their local devices,
35+
Integrate Island's advanced data loss prevention (DLP) capabilities with
36+
Coder's cloud development environment (CDE), enabling you to control the
37+
"last mile" between developers' CDE and their local devices,
3838
ensuring that sensitive IP remains in your centralized environment.
3939

4040
### Block cut, copy, paste, printing, screen share
4141

42-
1. [Create a Data Sandbox Profile][data-sandbox].
42+
1. [Create a Data Sandbox Profile](https://documentation.island.io/docs/create-and-configure-a-data-sandbox-profile).
4343

4444
1. Configure the following actions to allow/block (based on your security
4545
requirements).
@@ -49,27 +49,27 @@ ensuring that sensitive IP remains in your centralized environment.
4949
- Save Page
5050
- Clipboard Limitations
5151

52-
1. [Create a Policy Rule][policy-rule] to apply the Data Sandbox Profile.
52+
1. [Create a Policy Rule](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general) to apply the Data Sandbox Profile.
5353

5454
1. Define the Coder Application group as the Destination Object.
5555

5656
1. Define the Data Sandbox Profile as the Action in the Last Mile Protection
5757
section.
5858

59-
### Conditionally allow copy on Coder’s CLI authentication page
59+
### Conditionally allow copy on Coder's CLI authentication page
6060

61-
1. [Create a URL Object][policy-rule] with the following configuration.
61+
1. [Create a URL Object](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general) with the following configuration.
6262

6363
- **Include**
6464
- **URL type**: Wildcard
6565
- **URL address**: `coder.example.com/cli-auth`
6666
- **Casing**: Insensitive
6767

68-
1. [Create a Data Sandbox Profile][data-sandbox].
68+
1. [Create a Data Sandbox Profile](https://documentation.island.io/docs/create-and-configure-a-data-sandbox-profile).
6969

7070
1. Configure action to allow copy/paste.
7171

72-
1. [Create a Policy Rule][policy-rule] to apply the Data Sandbox Profile.
72+
1. [Create a Policy Rule](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general) to apply the Data Sandbox Profile.
7373

7474
1. Define the URL Object you created as the Destination Object.
7575

@@ -80,10 +80,10 @@ ensuring that sensitive IP remains in your centralized environment.
8080

8181
1. Create a Protection Profiles for both upload/download.
8282

83-
- [Upload documentation][upload-docs]
84-
- [Download documentation][download-docs]
83+
- [Upload documentation](https://documentation.island.io/docs/create-and-configure-an-upload-protection-profile)
84+
- [Download documentation](https://documentation.island.io/v1/docs/en/create-and-configure-a-download-protection-profile)
8585

86-
1. [Create a Policy Rule][policy-rule] to apply the Protection Profiles.
86+
1. [Create a Policy Rule](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general) to apply the Protection Profiles.
8787

8888
1. Define the Coder Application group as the Destination Object.
8989

@@ -92,9 +92,9 @@ ensuring that sensitive IP remains in your centralized environment.
9292

9393
### Scan files for sensitive data
9494

95-
1. [Create a Data Loss Prevention scanner][dlp-scanner].
95+
1. [Create a Data Loss Prevention scanner](https://documentation.island.io/docs/create-a-data-loss-prevention-scanner).
9696

97-
1. [Create a Policy Rule][policy-rule] to apply the DLP Scanner.
97+
1. [Create a Policy Rule](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general) to apply the DLP Scanner.
9898

9999
1. Define the Coder Application group as the Destination Object.
100100

@@ -103,7 +103,7 @@ ensuring that sensitive IP remains in your centralized environment.
103103
## Application Awareness and Boundaries
104104

105105
Ensure that Coder is only accessed through the Island browser, guaranteeing that
106-
your browser-level DLP policies are always enforced, and developers can’t
106+
your browser-level DLP policies are always enforced, and developers can't
107107
sidestep such policies simply by using another browser.
108108

109109
### Configure browser enforcement, conditional access policies
@@ -114,9 +114,9 @@ sidestep such policies simply by using another browser.
114114
The configured IdP must be the same for both Coder and Island
115115
</blockquote>
116116

117-
- [Azure Active Directory/Entra ID][island-entra]
118-
- [Okta][island-okta]
119-
- [Google][island-google]
117+
- [Azure Active Directory/Entra ID](https://documentation.island.io/docs/configure-browser-enforcement-for-island-with-azure-ad#create-and-apply-a-conditional-access-policy)
118+
- [Okta](https://documentation.island.io/docs/configure-browser-enforcement-for-island-with-okta)
119+
- [Google](https://documentation.island.io/docs/configure-browser-enforcement-for-island-with-google-enterprise)
120120

121121
## Browser Activity Logging
122122

@@ -125,7 +125,7 @@ screenshots, mouse clicks, and keystrokes.
125125

126126
### Activity Logging Module
127127

128-
1. [Create an Activity Logging Profile][logging-profile]. Supported browser
128+
1. [Create an Activity Logging Profile](https://documentation.island.io/docs/create-and-configure-an-activity-logging-profile). Supported browser
129129
events include:
130130

131131
- Web Navigation
@@ -138,7 +138,7 @@ screenshots, mouse clicks, and keystrokes.
138138
- Mouse Clicks
139139
- Keystrokes
140140

141-
1. [Create a Policy Rule][policy-rule] to apply the Activity Logging Profile.
141+
1. [Create a Policy Rule](https://documentation.island.io/docs/create-and-configure-a-policy-rule-general) to apply the Activity Logging Profile.
142142

143143
1. Define the Coder Application group as the Destination Object.
144144

@@ -147,38 +147,12 @@ screenshots, mouse clicks, and keystrokes.
147147

148148
## Identity-aware logins (SSO)
149149

150-
Integrate Island&rsquo;s identity management system with Coder&rsquo;s
150+
Integrate Island's identity management system with Coder's
151151
authentication mechanisms to enable identity-aware logins.
152152

153153
### Configure single sign-on (SSO) seamless authentication between Coder and Island
154154

155155
Configure the same identity provider (IdP) for both your Island and Coder
156-
deployment. Upon initial login to the Island browser, the user&rsquo;s session
156+
deployment. Upon initial login to the Island browser, the user's session
157157
token will automatically be passed to Coder and authenticate their Coder
158158
session.
159-
160-
<!-- Reference links -->
161-
162-
[island]: https://www.island.io/
163-
[app-group]:
164-
https://documentation.island.io/docs/create-and-configure-an-application-group-object
165-
[data-sandbox]:
166-
https://documentation.island.io/docs/create-and-configure-a-data-sandbox-profile
167-
[policy-rule]:
168-
https://documentation.island.io/docs/create-and-configure-a-policy-rule-general
169-
[url-object]:
170-
https://documentation.island.io/docs/create-and-configure-a-policy-rule-general
171-
[logging-profile]:
172-
https://documentation.island.io/docs/create-and-configure-an-activity-logging-profile
173-
[dlp-scanner]:
174-
https://documentation.island.io/docs/create-a-data-loss-prevention-scanner
175-
[upload-docs]:
176-
https://documentation.island.io/docs/create-and-configure-an-upload-protection-profile
177-
[download-docs]:
178-
https://documentation.island.io/v1/docs/en/create-and-configure-a-download-protection-profile
179-
[island-entra]:
180-
https://documentation.island.io/docs/configure-browser-enforcement-for-island-with-azure-ad#create-and-apply-a-conditional-access-policy
181-
[island-okta]:
182-
https://documentation.island.io/docs/configure-browser-enforcement-for-island-with-okta
183-
[island-google]:
184-
https://documentation.island.io/docs/configure-browser-enforcement-for-island-with-google-enterprise

docs/admin/integrations/jfrog-artifactory.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ To set this up, follow these steps:
134134
<blockquote class="info">
135135

136136
The admin-level access token is used to provision user tokens and is never exposed to developers or stored in workspaces.
137-
137+
138138
</blockquote>
139139

140140
If you don't want to use the official modules, you can read through the [example

docs/admin/integrations/jfrog-xray.md

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ March 17, 2024
1111

1212
---
1313

14-
This guide describes the process of integrating [JFrog Xray][] to Coder Kubernetes-backed
15-
workspaces using Coder&rsquo;s [JFrog Xray Integration][`coder-xray`].
14+
This guide describes the process of integrating [JFrog Xray](https://jfrog.com/xray/) to Coder Kubernetes-backed
15+
workspaces using Coder's [JFrog Xray Integration](https://github.com/coder/coder-xray).
1616

1717
## Prerequisites
1818

@@ -21,10 +21,10 @@ workspaces using Coder&rsquo;s [JFrog Xray Integration][`coder-xray`].
2121

2222
## Deploy the **Coder - JFrog Xray** Integration
2323

24-
1. Create a JFrog Platform [Access Token][] with a user that has the `read` [permission][]
24+
1. Create a JFrog Platform [Access Token](https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens) with a user that has the `read` [permission](https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions)
2525
for the repositories you want to scan.
2626

27-
1. Create a Coder [token][] with a user that has the [`owner`][roles] role.
27+
1. Create a Coder [token](../../reference/cli/tokens_create.md#tokens-create) with a user that has the [`owner`](../users#roles) role.
2828

2929
1. Create Kubernetes secrets for the JFrog Xray and Coder tokens.
3030

@@ -58,10 +58,9 @@ workspaces using Coder&rsquo;s [JFrog Xray Integration][`coder-xray`].
5858

5959
<blockquote class="admonition warning">
6060

61-
**Note**: To authenticate with the Artifactory registry, you may need to
62-
create a [Docker config][docker-advanced-topics] and use it in the
63-
`imagePullSecrets` field of the Kubernetes Pod. See the [**Defining
64-
ImagePullSecrets for Coder workspaces**][image-pull-secret] guide for more
61+
To authenticate with the Artifactory registry, you may need to
62+
create a [Docker config](https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-advanced-topics) and use it in the
63+
`imagePullSecrets` field of the Kubernetes Pod. See the [Defining ImagePullSecrets for Coder workspaces](../../tutorials/image-pull-secret.md) guide for more
6564
information.
6665

6766
</blockquote>
@@ -72,18 +71,3 @@ Once installed, configured workspaces will now have a banner appear on any
7271
workspace with vulnerabilities reported by JFrog Xray.
7372

7473
<img alt="JFrog Xray Integration" src="../../images/guides/xray-integration/example.png" />
75-
76-
<!-- References -->
77-
78-
[JFrog Xray]: https://jfrog.com/xray/
79-
[JFrog Xray Integration]: https://github.com/coder/coder-xray
80-
[`coder-xray`]: https://github.com/coder/coder-xray
81-
[docker-advanced-topics]:
82-
https://jfrog.com/help/r/jfrog-artifactory-documentation/docker-advanced-topics
83-
[image-pull-secret]: ../../tutorials/image-pull-secret.md
84-
[token]: ../../reference/cli/tokens_create.md#tokens-create
85-
[roles]: ../users#roles
86-
[permission]:
87-
https://jfrog.com/help/r/jfrog-platform-administration-documentation/permissions
88-
[access token]:
89-
https://jfrog.com/help/r/jfrog-platform-administration-documentation/access-tokens

docs/admin/integrations/prometheus.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Coder exposes many metrics which can be consumed by a Prometheus server, and
44
give insight into the current state of a live Coder deployment.
55

66
If you don't have a Prometheus server installed, you can follow the Prometheus
7-
[Getting started][prom-get-started] guide.
7+
[Getting started](https://prometheus.io/docs/prometheus/latest/getting_started/) guide.
88

99
## Enable Prometheus metrics
1010

@@ -18,7 +18,7 @@ use either the environment variable `CODER_PROMETHEUS_ADDRESS` or the flag
1818
address.
1919

2020
If `coder server --prometheus-enable` is started locally, you can preview the
21-
metrics endpoint in your browser or by using curl.
21+
metrics endpoint in your browser or with `curl`:
2222

2323
```console
2424
$ curl http://localhost:2112/
@@ -30,7 +30,7 @@ coderd_api_active_users_duration_hour 0
3030

3131
### Kubernetes deployment
3232

33-
The Prometheus endpoint can be enabled in the [Helm chart's][coder-helm]
33+
The Prometheus endpoint can be enabled in the [Helm chart's](https://github.com/coder/coder/tree/main/helm)
3434
`values.yml` by setting the environment variable `CODER_PROMETHEUS_ADDRESS` to
3535
`0.0.0.0:2112`. The environment variable `CODER_PROMETHEUS_ENABLE` will be
3636
enabled automatically. A Service Endpoint will not be exposed; if you need to
@@ -100,12 +100,6 @@ You must first enable `coderd_agentstats_*` with the flag
100100
`CODER_PROMETHEUS_COLLECT_AGENT_STATS` before they can be retrieved from the
101101
deployment. They will always be available from the agent.
102102

103-
<!-- References -->
104-
105-
[prom-get-started]:
106-
https://prometheus.io/docs/prometheus/latest/getting_started/
107-
[coder-helm]: https://github.com/coder/coder/tree/main/helm
108-
109103
<!-- Code generated by 'make docs/admin/integrations/prometheus.md'. DO NOT EDIT -->
110104

111105
| Name | Type | Description | Labels |

docs/admin/integrations/vault.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ August 05, 2024
1111

1212
---
1313

14-
This guide describes the process of integrating [HashiCorp Vault][] into Coder workspaces.
14+
This guide describes the process of integrating [HashiCorp Vault](https://www.vaultproject.io/) into Coder workspaces.
1515

1616
Coder makes it easy to integrate HashiCorp Vault with your workspaces by
1717
providing official Terraform modules to integrate Vault with Coder. This guide
1818
will show you how to use these modules to integrate HashiCorp Vault with Coder.
1919

2020
## The `vault-github` module
2121

22-
The [`vault-github`][] module is a Terraform module that allows you to
22+
The [`vault-github`](https://registry.coder.com/modules/vault-github) module is a Terraform module that allows you to
2323
authenticate with Vault using a GitHub token. This module uses the existing
24-
GitHub [external authentication][] to get the token and authenticate with Vault.
24+
GitHub [external authentication](../external-auth.md) to get the token and authenticate with Vault.
2525

2626
To use this module, add the following code to your Terraform configuration.
2727

@@ -43,9 +43,3 @@ a secret stored in the KV backend.
4343
```shell
4444
vault kv get -namespace=YOUR_NAMESPACE -mount=MOUNT_NAME SECRET_NAME
4545
```
46-
47-
<!-- References -->
48-
49-
[HashiCorp Vault]: https://www.vaultproject.io/
50-
[external authentication]: ../external-auth.md
51-
[`vault-github`]: https://registry.coder.com/modules/vault-github

0 commit comments

Comments
 (0)