mirror of
https://github.com/coder/coder.git
synced 2026-09-22 05:05:20 +08:00
Nick Vigilante
ed908ed019
Closes [DOCS-415](https://linear.app/codercom/issue/DOCS-415). ## TL;DR Repoints 7 broken links across 5 docs files that the 2026-06-22 weekly `check-docs.yml` Linkspector run flagged. Two other links from the same run (the dead `nix` ref and the dead `reflectoring.io` ref in `CONTRIBUTING.md`) were already folded into [#26341](https://github.com/coder/coder/pull/26341). ## Why Broken external and anchor links degrade reader trust, leak SEO juice, and make the docs look stale. The weekly `check-docs` job exists precisely to catch this kind of rot before customers do; the surfacing-to-fix turnaround on these 7 is one PR. Run that surfaced them: [actions/runs/27948011619 job 82697664858](https://github.com/coder/coder/actions/runs/27948011619/job/82697664858). ## Scope | File | Line(s) | Old target | New target | Why | |------|---------|-----------|------------|-----| | `docs/tutorials/best-practices/organizations.md` | 62 | anchor `#update-template-metadata-by-id` | `#update-template-settings-by-id` | API endpoint renamed in [#19228](https://github.com/coder/coder/pull/19228) (Aug 2025). New heading at line 1105 of `docs/reference/api/templates.md`. | | `docs/install/registry-mirror-artifactory.md` | 197 | JFrog `terraform-registry` | `terraform-opentofu-and-terraform-backend-repositories` | JFrog consolidated their Terraform / OpenTofu / Backend docs into a single page. | | `docs/admin/templates/extending-templates/modules.md` | 76, 206 | JFrog `set-up-a-terraform-module/provider-registry` and `terraform-registry` | same consolidated JFrog page (root, no anchor) | Same JFrog consolidation. Anchor dropped, see decision log. | | `docs/admin/integrations/dx-data-cloud.md` | 84 | `https://help.getdx.com/en/` | `https://docs.getdx.com/` | DX migrated their help center to a separate docs domain. | | `docs/about/contributing/frontend.md` | 37, 71 | `https://reactrouter.com/en/main` | `https://reactrouter.com/` | React Router dropped the `/en/main` prefix. | ## Validation - All 7 replacement URLs return HTTP 200 (manual `curl -L -o /dev/null -w '%{http_code}'` per URL; linkspector's puppeteer crashed in the agent env, so it was run case-by-case) - `make lint/markdown lint/emdash` clean locally - Pre-commit hook (`scripts/githooks/pre-commit` -> `make pre-commit-light`) clean - No `/docs/` route changes; pure markdown content ## Not triggering `/coder-agents-review` Docs-only markdown edit, no CI or build config changes; per `AGENTS.md` the bot review is reserved for product / CI changes. `doc-check` handles this category. ## Pre-mortem | Concern | Mitigation | |---|---| | Replacement URL also turns out to be broken later | All 7 verified HTTP 200 today; next weekly `check-docs` run will catch any future regression. | | JFrog anchor drop on `modules.md` (76, 206) loses navigation context | Verified the consolidated JFrog page has no clean section anchor for the original target; linking the root page is the honest fix. If JFrog ships a better TOC anchor later, a follow-up can reattach. | | Anchor rename in `organizations.md` was actually a different rename | Confirmed via PR #19228 (Aug 2025) which is the exact rename that produced `## Update template settings by ID`. | <details> <summary>Decision log</summary> **Why drop the anchor on the JFrog `modules.md` links (76 + 206)**: JFrog's new consolidated page (`/terraform-opentofu-and-terraform-backend-repositories`) doesn't expose the original `set-up-a-terraform-module/provider-registry` section as a fragment-link target. The honest fix is to link the page root; readers can scroll. The `registry-mirror-artifactory.md:197` reference uses the same root link for symmetry. **Why DX `docs.getdx.com` over `help.getdx.com`**: DX's help center at `help.getdx.com/en/` now returns 404. They moved to a separate `docs.getdx.com` domain with a different content structure. Linking the docs root is the closest analog to the original "browse our docs" intent. **Why React Router root over `/en/main`**: React Router unified their docs under the root URL. The `/en/main` prefix is no longer routable. The root URL is the canonical successor. </details> <details> <summary>CI: <code>audit-docs-paths</code> failure (pre-existing, unrelated)</summary> The `audit-docs-paths` job in `.github/workflows/weekly-docs.yaml` fails on this PR because its `Fetch redirects.json` step issues an unauthenticated `curl` to a file in private `coder/coder.com` and gets a 404 (exit code 22). Same failure on every recent PR in this repo. Tracked in [DOCS-409](https://linear.app/codercom/issue/DOCS-409) and fixed in [#26571](https://github.com/coder/coder/pull/26571), which authenticates the fetch through the Contents API. My changes are docs-content only (5 markdown files, 7 line changes) and don't touch the TS/TSX paths or `redirects.json` that the audit examines, so this is a pre-existing CI break, not a regression introduced here. </details> --- *Generated by Coder Agents on @nickvigilante's behalf.*
88 lines
3.0 KiB
Markdown
88 lines
3.0 KiB
Markdown
# DX
|
||
|
||
[DX](https://getdx.com) is a developer intelligence platform used by engineering
|
||
leaders and platform engineers.
|
||
|
||
DX uses metadata attributes to assign information to individual users.
|
||
While it's common to segment users by `role`, `level`, or `geo`, it’s become increasingly
|
||
common to use DX attributes to better understand usage and adoption of tools.
|
||
|
||
You can create a `Coder` attribute in DX to segment and analyze the impact of Coder usage on a developer’s work, including:
|
||
|
||
- Understanding the needs of power users or low Coder usage across the org
|
||
- Correlate Coder usage with qualitative and quantitative engineering metrics,
|
||
such as PR throughput, deployment frequency, deep work, dev environment toil, and more.
|
||
- Personalize user experiences
|
||
|
||
## Requirements
|
||
|
||
- A DX subscription
|
||
- Access to Coder user data through the Coder CLI, Coder API, an IdP, or an existing Coder-DX integration
|
||
- Coordination with your DX Customer Success Manager
|
||
|
||
## Extract Your Coder User List
|
||
|
||
<div class="tabs">
|
||
|
||
You can use the Coder CLI, Coder API, or your Identity Provider (IdP) to extract your list of users.
|
||
|
||
If your organization already uses the Coder-DX integration, you can find a list of active Coder users directly within DX.
|
||
|
||
### CLI
|
||
|
||
Use `users list` to export the list of users to a CSV file:
|
||
|
||
```shell
|
||
coder users list > users.csv
|
||
```
|
||
|
||
Visit the [users list](../../reference/cli/users_list.md) documentation for more options.
|
||
|
||
### API
|
||
|
||
Use [get users](../../reference/api/users.md#get-users):
|
||
|
||
```bash
|
||
curl -X GET http://coder-server:8080/api/v2/users \
|
||
-H 'Accept: application/json' \
|
||
-H 'Coder-Session-Token: API_KEY'
|
||
```
|
||
|
||
To export the results to a CSV file, you can use the `jq` tool to process the JSON response:
|
||
|
||
```bash
|
||
curl -X GET http://coder-server:8080/api/v2/users \
|
||
-H 'Accept: application/json' \
|
||
-H 'Coder-Session-Token: API_KEY' | \
|
||
jq -r '.users | (map(keys) | add | unique) as $cols | $cols, (.[] | [.[$cols[]]] | @csv)' > users.csv
|
||
```
|
||
|
||
Visit the [get users](../../reference/api/users.md#get-users) documentation for more options.
|
||
|
||
### IdP
|
||
|
||
If your organization uses a centralized IdP to manage user accounts, you can extract user data directly from your IdP.
|
||
|
||
This is particularly useful if you need additional user attributes managed within your IdP.
|
||
|
||
</div>
|
||
|
||
## Contact your DX Customer Success Manager
|
||
|
||
Provide the file to your dedicated DX Customer Success Manager (CSM).
|
||
|
||
Your CSM will import the CSV of individuals using Coder, as well as usage frequency (if applicable) into DX to create a `Coder` attribute.
|
||
|
||
After the attribute is uploaded, you'll have a Coder filter option within your DX reports allowing you to:
|
||
|
||
- Perform cohort analysis (Coder user vs non-user)
|
||
- Understand unique behaviors and patterns across your Coder users
|
||
- Run a [study](https://getdx.com/studies/) or setup a [PlatformX](https://getdx.com/platformx/) event for deeper analysis
|
||
|
||
## Related Resources
|
||
|
||
- [DX Data Cloud Documentation](https://docs.getdx.com/)
|
||
- [Coder CLI](../../reference/cli/users.md)
|
||
- [Coder API](../../reference/api/users.md)
|
||
- [PlatformX Integration](./platformx.md)
|