@@ -72,12 +72,12 @@ After setup, open Grafana at **http://localhost:3002** (admin / admin). DORA and
7272
7373Four concepts to understand — then every command makes sense:
7474
75- | Concept | What It Is |
76- | ---------| -----------|
77- | ** Connection** | An authenticated link to a data source (GitHub, Copilot, Jenkins). Each gets its own PAT/credentials. |
78- | ** Scope** | * What* to collect — specific repos for GitHub, an org/enterprise for Copilot, jobs for Jenkins. |
79- | ** Project** | Groups connections + scopes into a single view with DORA metrics enabled. |
80- | ** Blueprint** | The sync schedule (cron). Created automatically with the project. |
75+ | Concept | What It Is |
76+ | ---------| -----------|
77+ | ** Connection** | An authenticated link to a data source (GitHub, Copilot, Jenkins). Each gets its own PAT/credentials. |
78+ | ** Scope** | * What* to collect — specific repos for GitHub, an org/enterprise for Copilot, jobs for Jenkins. |
79+ | ** Project** | Groups connections + scopes into a single view with DORA metrics enabled. |
80+ | ** Blueprint** | The sync schedule (cron). Created automatically with the project. |
8181
8282<!-- SCREENSHOT: Config UI project page showing connections → scopes → project hierarchy -->
8383
@@ -117,12 +117,12 @@ The CLI will prompt you for your PAT. You can also pass `--token`, use an `--env
117117# GitHub (repos, PRs, workflows, deployments)
118118gh devlake configure connection add --plugin github --org my-org
119119
120- # Copilot (usage metrics, seats, acceptance rates)
121- gh devlake configure connection add --plugin gh-copilot --org my-org
122-
123- # Jenkins (jobs and build data for DORA)
124- gh devlake configure connection add --plugin jenkins --endpoint https://jenkins.example.com --username admin --token myapitoken
125- ```
120+ # Copilot (usage metrics, seats, acceptance rates)
121+ gh devlake configure connection add --plugin gh-copilot --org my-org
122+
123+ # Jenkins (jobs and build data for DORA)
124+ gh devlake configure connection add --plugin jenkins --endpoint https://jenkins.example.com --username admin --token myapitoken
125+ ```
126126
127127The CLI tests each connection before saving. On success:
128128
@@ -142,12 +142,12 @@ Tell DevLake which repos or orgs to collect from:
142142# GitHub — pick repos interactively, or pass --repos explicitly
143143gh devlake configure scope add --plugin github --org my-org
144144
145- # Copilot — org-level metrics
146- gh devlake configure scope add --plugin gh-copilot --org my-org
147-
148- # Jenkins — pick jobs interactively (or pass --jobs)
149- gh devlake configure scope add --plugin jenkins --org my-org
150- ```
145+ # Copilot — org-level metrics
146+ gh devlake configure scope add --plugin gh-copilot --org my-org
147+
148+ # Jenkins — pick jobs interactively (or pass --jobs)
149+ gh devlake configure scope add --plugin jenkins --org my-org
150+ ```
151151
152152DORA patterns (deployment workflow, production environment, incident label) use sensible defaults. See [ docs/configure-scope.md] ( docs/configure-scope.md ) for overrides.
153153
@@ -188,14 +188,14 @@ For the full guide, see [Day-2 Operations](docs/day-2.md).
188188
189189## Supported Plugins
190190
191- | Plugin | Status | What It Collects | Required PAT scopes |
192- | --------| --------| ------------------| ---------------------|
193- | GitHub | ✅ Available | Repos, PRs, issues, workflows, deployments (DORA) | ` repo ` , ` read:org ` , ` read:user ` |
194- | GitHub Copilot | ✅ Available | Usage metrics, seats, acceptance rates | ` manage_billing:copilot ` , ` read:org ` (+ ` read:enterprise ` for enterprise metrics) |
195- | Jenkins | ✅ Available | Jobs, builds, deployments (DORA) | Username + API token/password |
196- | Jira | ✅ Available | Boards, issues, sprints (change lead time, cycle time) | API token (permissions from user account) |
197- | Azure DevOps | ✅ Available | Repos, pipelines, deployments (DORA) | PAT with repo and pipeline access |
198- | GitLab | ✅ Available | Repos, MRs, pipelines, deployments (DORA) | ` read_api ` , ` read_repository ` |
191+ | Plugin | Status | What It Collects | Required PAT scopes |
192+ | --------| --------| ------------------| ---------------------|
193+ | GitHub | ✅ Available | Repos, PRs, issues, workflows, deployments (DORA) | ` repo ` , ` read:org ` , ` read:user ` |
194+ | GitHub Copilot | ✅ Available | Usage metrics, seats, acceptance rates | ` manage_billing:copilot ` , ` read:org ` (+ ` read:enterprise ` for enterprise metrics) |
195+ | Jenkins | ✅ Available | Jobs, builds, deployments (DORA) | Username + API token/password |
196+ | Jira | ✅ Available | Boards, issues, sprints (change lead time, cycle time) | API token (permissions from user account) |
197+ | Azure DevOps | ✅ Available | Repos, pipelines, deployments (DORA) | PAT with repo and pipeline access |
198+ | GitLab | ✅ Available | Repos, MRs, pipelines, deployments (DORA) | ` read_api ` , ` read_repository ` |
199199
200200See [ Token Handling] ( docs/token-handling.md ) for env key names and multi-plugin ` .devlake.env ` examples.
201201
0 commit comments