docs: fix stale fork note and erroneous deploy steps in README#144
docs: fix stale fork note and erroneous deploy steps in README#144
Conversation
Co-authored-by: ewega <26189114+ewega@users.noreply.github.com>
|
@copilot I'm also noticing the deploy steps in the Readme might be erroneous. Why are we telling users to do docker compose up ? That's being handled by the gh-devlake |
Co-authored-by: ewega <26189114+ewega@users.noreply.github.com>
Good catch — |
There was a problem hiding this comment.
Pull request overview
Updates the project README to remove outdated guidance about Copilot plugin availability and to correct local deployment instructions so they match how gh devlake deploy local is intended to be used.
Changes:
- Removed a stale note about the Copilot metrics plugin only being available in a fork.
- Removed manual
docker compose up -dsteps from Quick Start and step-by-step deploy instructions. - Updated the Step 1 deploy description to state that
deploy localstarts the stack and waits for health.
| ``` | ||
|
|
||
| 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. |
| > **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" --> |
The README contained inaccurate information in two areas that needed correction.
Changes
[!NOTE]callout stating the Copilot metrics plugin was only available in theDevExpGBB/incubator-devlakefork — that upstream PR has since merged into the official Apache images.cd devlake && docker compose up -dmanually. This is handled automatically bygh devlake deploy local, which starts the containers and waits until DevLake is healthy — no manual intervention needed.Original prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.