docs: fix list item nesting

coder · EdwardAngert · Jan 3, 2025 · Nov 14, 2024 · Nov 14, 2024 · Nov 14, 2024
commit 004ab1a76b5c64c07f68d5b66d1dc971b3ac7827
diff --git a/docs/admin/integrations/jfrog-artifactory.md b/docs/admin/integrations/jfrog-artifactory.md
@@ -37,139 +37,146 @@ two type of modules that automate the JFrog Artifactory and Coder integration.
 
 This module is usable by JFrog self-hosted (on-premises) Artifactory as it
 requires configuring a custom integration. This integration benefits from
-Coder's [external-auth](https://coder.com/docs/admin/external-auth) feature and
+Coder's [external-auth][] feature and
 allows each user to authenticate with Artifactory using an OAuth flow and issues
 user-scoped tokens to each user.
 
 To set this up, follow these steps:
 
 1. Modify your Helm chart `values.yaml` for JFrog Artifactory to add,
 
-```yaml
-artifactory:
-  enabled: true
-  frontend:
-  extraEnvironmentVariables:
-    - name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION
-      value: "true"
-  access:
-  accessConfig:
-    integrations-enabled: true
-    integration-templates:
-      - id: "1"
-        name: "CODER"
-        redirect-uri: "https://CODER_URL/external-auth/jfrog/callback"
-        scope: "applied-permissions/user"
-```
-
-> Note Replace `CODER_URL` with your Coder deployment URL, e.g.,
-> <coder.example.com>
+	```yaml
+	artifactory:
+	  enabled: true
+	  frontend:
+	  extraEnvironmentVariables:
+	    - name: JF_FRONTEND_FEATURETOGGLER_ACCESSINTEGRATION
+	      value: "true"
+	  access:
+	  accessConfig:
+	    integrations-enabled: true
+	    integration-templates:
+	      - id: "1"
+	        name: "CODER"
+	        redirect-uri: "https://CODER_URL/external-auth/jfrog/callback"
+	        scope: "applied-permissions/user"
+	```
+	<blockquote class="admonition info">
+
+	Replace `CODER_URL` with your JFrog Artifactory base URL; for example, `coder.mycompany.com`.
+
+	</blockquote>
 
 2. Create a new Application Integration by going to
    <https://JFROG_URL/ui/admin/configuration/integrations/new> and select the
    Application Type as the integration you created in step 1.
 
-![JFrog Platform new integration](../../images/guides/artifactory-integration/jfrog-oauth-app.png)
-
-3. Add a new
-   [external authentication](https://coder.com/docs/admin/external-auth) to
-   Coder by setting these env variables,
-
-```env
-# JFrog Artifactory External Auth
-CODER_EXTERNAL_AUTH_1_ID="jfrog"
-CODER_EXTERNAL_AUTH_1_TYPE="jfrog"
-CODER_EXTERNAL_AUTH_1_CLIENT_ID="YYYYYYYYYYYYYYY"
-CODER_EXTERNAL_AUTH_1_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXX"
-CODER_EXTERNAL_AUTH_1_DISPLAY_NAME="JFrog Artifactory"
-CODER_EXTERNAL_AUTH_1_DISPLAY_ICON="/icon/jfrog.svg"
-CODER_EXTERNAL_AUTH_1_AUTH_URL="https://JFROG_URL/ui/authorization"
-CODER_EXTERNAL_AUTH_1_SCOPES="applied-permissions/user"
-```
-
-> Note Replace `JFROG_URL` with your JFrog Artifactory base URL, e.g.,
-> <example.jfrog.io>
-
-4. Create or edit a Coder template and use the
-   [JFrog-OAuth](https://registry.coder.com/modules/jfrog-oauth) module to
+   <img alt="JFrog Platform new integration" src="../../images/guides/artifactory-integration/jfrog-oauth-app.png" />
+
+3. Add a new [external authentication][external-auth] to Coder by setting these
+   environment variables in a manner consistent with your Coder deployment.
+
+	```env
+	# JFrog Artifactory External Auth
+	CODER_EXTERNAL_AUTH_1_ID="jfrog"
+	CODER_EXTERNAL_AUTH_1_TYPE="jfrog"
+	CODER_EXTERNAL_AUTH_1_CLIENT_ID="YYYYYYYYYYYYYYY"
+	CODER_EXTERNAL_AUTH_1_CLIENT_SECRET="XXXXXXXXXXXXXXXXXXX"
+	CODER_EXTERNAL_AUTH_1_DISPLAY_NAME="JFrog Artifactory"
+	CODER_EXTERNAL_AUTH_1_DISPLAY_ICON="/icon/jfrog.svg"
+	CODER_EXTERNAL_AUTH_1_AUTH_URL="https://JFROG_URL/ui/authorization"
+	CODER_EXTERNAL_AUTH_1_SCOPES="applied-permissions/user"
+	```
+	<blockquote class="admonition info">
+
+	Replace `JFROG_URL` with your JFrog Artifactory base URL; for example, `my-company.jfrog.io`.
+
+	</blockquote>
+
+4. Create or edit a Coder template and use the [JFrog-OAuth][] module to
    configure the integration.
 
-```tf
-module "jfrog" {
-  source = "registry.coder.com/modules/jfrog-oauth/coder"
-  version = "1.0.0"
-  agent_id = coder_agent.example.id
-  jfrog_url = "https://jfrog.example.com"
-  configure_code_server = true # this depends on the code-server
-  username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
-  package_managers = {
-    "npm": "npm",
-    "go": "go",
-    "pypi": "pypi"
-  }
-}
-```
+	```tf
+	module "jfrog" {
+	  source = "registry.coder.com/modules/jfrog-oauth/coder"
+	  version = "1.0.0"
+	  agent_id = coder_agent.example.id
+	  jfrog_url = "https://jfrog.example.com"
+	  configure_code_server = true # this depends on the code-server
+	  username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
+	  package_managers = {
+	    "npm": "npm",
+	    "go": "go",
+	    "pypi": "pypi"
+	  }
+	}
+	```
 
 ### JFrog-Token
 
-This module makes use of the
-[Artifactory terraform provider](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs)
+This module makes use of the [Artifactory terraform provider][artifactory-tf-provider]
 and an admin-scoped token to create user-scoped tokens for each user by matching
 their Coder email or username with Artifactory. This can be used for both SaaS
 and self-hosted(on-premises) Artifactory instances.
 
 To set this up, follow these steps:
 
 1. Get a JFrog access token from your Artifactory instance. The token must be an
-   [admin token](https://registry.terraform.io/providers/jfrog/artifactory/latest/docs#access-token)
-   with scope `applied-permissions/admin`.
-2. Create or edit a Coder template and use the
-   [JFrog-Token](https://registry.coder.com/modules/jfrog-token) module to
+   [admin token] with scope `applied-permissions/admin`.
+
+2. Create or edit a Coder template and use the [JFrog-Token][] module to
    configure the integration and pass the admin token. It is recommended to
    store the token in a sensitive terraform variable to prevent it from being
    displayed in plain text in the terraform state.
 
-```tf
-variable "artifactory_access_token" {
-  type      = string
-  sensitive = true
-}
-
-module "jfrog" {
-  source = "registry.coder.com/modules/jfrog-token/coder"
-  version = "1.0.0"
-  agent_id = coder_agent.example.id
-  jfrog_url = "https://example.jfrog.io"
-  configure_code_server = true # this depends on the code-server
-  artifactory_access_token = var.artifactory_access_token
-  package_managers = {
-    "npm": "npm",
-    "go": "go",
-    "pypi": "pypi"
-  }
-}
-```
+	```tf
+	variable "artifactory_access_token" {
+	  type      = string
+	  sensitive = true
+	}
+
+	module "jfrog" {
+	  source = "registry.coder.com/modules/jfrog-token/coder"
+	  version = "1.0.0"
+	  agent_id = coder_agent.example.id
+	  jfrog_url = "https://example.jfrog.io"
+	  configure_code_server = true # this depends on the code-server
+	  artifactory_access_token = var.artifactory_access_token
+	  package_managers = {
+	    "npm": "npm",
+	    "go": "go",
+	    "pypi": "pypi"
+	  }
+	}
+	```
 
 <blockquote class="info">
 The admin-level access token is used to provision user tokens and is never exposed to
 developers or stored in workspaces.
 </blockquote>
 
-If you do not want to use the official modules, you can check example template
-that uses Docker as the underlying compute
-[here](https://github.com/coder/coder/tree/main/examples/jfrog/docker). The same
-concepts apply to all compute types.
+If you don't want to use the official modules, you can read through the
+[example template][docker-template], which uses Docker as the underlying compute.
+The same concepts apply to all compute types.
 
 ## Offline Deployments
 
-See the
-[offline deployments](../templates/extending-templates/modules.md#offline-installations)
-section for instructions on how to use coder-modules in an offline environment
-with Artifactory.
+See the [offline deployments][] section for instructions on how to use
+coder-modules in an offline environment with Artifactory.
 
 ## More reading
 
-- See the full example template
-  [here](https://github.com/coder/coder/tree/main/examples/jfrog/docker).
+- See the [full example Docker template][docker-template].
+
 - To serve extensions from your own VS Code Marketplace, check out
-  [code-marketplace](https://github.com/coder/code-marketplace#artifactory-storage).
+  [code-marketplace][cm-artifactory].
+
+<!-- Reference Links -->
+[jfrog-oauth]: https://registry.coder.com/modules/jfrog-oauth
+[jfrog-token]: https://registry.coder.com/modules/jfrog-token
+[cm-artifactory]:https://github.com/coder/code-marketplace#artifactory-storage
+[offline deployments]: ../templates/extending-templates/modules.md#offline-installations
+[docker-template]: https://github.com/coder/coder/tree/main/examples/jfrog/docker
+[admin token]: https://registry.terraform.io/providers/jfrog/artifactory/latest/docs#access-token
+[artifactory-tf-provider]: https://registry.terraform.io/providers/jfrog/artifactory/latest/docs
+[external-auth]: https://coder.com/docs/admin/external-auth