Skip to content

docs: fix stale fork note and erroneous deploy steps in README #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ewega merged 3 commits into from
Mar 16, 2026
Merged

docs: fix stale fork note and erroneous deploy steps in README #144

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce36fe0
Initial plan
Copilot Mar 14, 2026
f7124ab
Remove outdated fork note for GitHub Copilot plugin (PR now merged)
Copilot Mar 14, 2026
4f624b7
docs: remove erroneous manual docker compose up steps from README
Copilot Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ This CLI makes that setup fast and repeatable from the terminal (instead of clic

> **Blog post:** [Beyond Copilot Dashboards: Measuring What AI Actually Changes](<!-- TODO: replace with actual blog URL -->) — why DORA + Copilot correlation matters and what this tool enables.

> [!NOTE]
> **GitHub Copilot plugin:** The Copilot metrics plugin is currently available in the [DevExpGBB/incubator-devlake](https://github.com/DevExpGBB/incubator-devlake) fork while the upstream PR ([apache/incubator-devlake#8728](https://github.com/apache/incubator-devlake/pull/8728)) is under review. The `deploy local` and `deploy azure` commands handle custom images automatically — no manual image builds needed. Once the PR merges, the official Apache images will include it.

<!-- SCREENSHOT: Grafana DORA dashboard + Copilot Adoption dashboard side-by-side — the "payoff" -->
<!-- SCREENSHOT:Grafana DORA dashboard + Copilot Adoption dashboard side-by-side — the "payoff" -->

---

Expand Down Expand Up @@ -53,8 +50,6 @@ gh devlake init

# Option 2: Step-by-step
gh devlake deploy local --dir ./devlake
cd devlake && docker compose up -d
# wait ~2 minutes, then:
gh devlake configure full
```

Expand Down Expand Up @@ -91,10 +86,9 @@ For a deeper explanation with diagrams, see [DevLake Concepts](docs/concepts.md)

```bash
gh devlake deploy local --dir ./devlake
cd devlake && docker compose up -d
```

Downloads Docker Compose files, generates secrets, and prepares the stack. Give it ~2 minutes after `docker compose up`. See [docs/deploy.md](docs/deploy.md) for flags and details.
Downloads Docker Compose files, generates secrets, starts the stack, and waits until DevLake is healthy. See [docs/deploy.md](docs/deploy.md) for flags and details.

<details>
<summary><strong>Deploying to Azure instead</strong></summary>
Expand Down
Loading