Skip to content

Commit 22b92b4

Browse files
committed
docs: fix dev compose filename and add working directory notes for OTel commands
1 parent a88e274 commit 22b92b4

4 files changed

Lines changed: 7 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ For distributed development:
231231
3. Build Store: `mvn clean package -pl hugegraph-store -am -DskipTests`
232232
4. Build Server with HStore backend: `mvn clean package -pl hugegraph-server -am -DskipTests`
233233

234-
See Docker Compose examples: `docker/` directory. Single-node quickstart (pre-built images): `docker/docker-compose.yml`. Single-node dev build (from source): `docker/docker-compose-dev.yml`. 3-node cluster: `docker/docker-compose-3pd-3store-3server.yml`. See `docker/README.md` for full setup guide.
234+
See Docker Compose examples: `docker/` directory. Single-node quickstart (pre-built images): `docker/docker-compose.yml`. Single-node dev build (from source): `docker/docker-compose.dev.yml`. 3-node cluster: `docker/docker-compose-3pd-3store-3server.yml`. See `docker/README.md` for full setup guide.
235235

236236
### Debugging Tips
237237

docker/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This directory contains Docker Compose files for running HugeGraph:
55
| File | Description |
66
|------|-------------|
77
| `docker-compose.yml` | Single-node cluster using pre-built images from Docker Hub |
8-
| `docker-compose-dev.yml` | Single-node cluster built from source (for developers) |
8+
| `docker-compose.dev.yml` | Single-node cluster built from source (for developers) |
99
| `docker-compose-3pd-3store-3server.yml` | 3-node distributed cluster (PD + Store + Server) |
1010

1111
## Prerequisites
@@ -48,7 +48,7 @@ Builds images locally from source Dockerfiles. Best for **developers** who want
4848

4949
```bash
5050
cd docker
51-
docker compose -f docker-compose-dev.yml up -d
51+
docker compose -f docker-compose.dev.yml up -d
5252
```
5353

5454
- Images: built from source via `build: context: ..` with Dockerfiles
@@ -59,7 +59,7 @@ docker compose -f docker-compose-dev.yml up -d
5959

6060
### Key Differences
6161

62-
| | `docker-compose.yml` (quickstart) | `docker-compose-dev.yml` (dev build) |
62+
| | `docker-compose.yml` (quickstart) | `docker-compose.dev.yml` (dev build) |
6363
|---|---|---|
6464
| **Images** | Pull from Docker Hub | Build from source |
6565
| **Who it's for** | End users | Developers |

hugegraph-server/hugegraph-dist/docker/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
9292
1. Start Open-Telemetry-Collector
9393

9494
```bash
95+
# Run from the repository root
9596
docker compose -f hugegraph-server/hugegraph-dist/docker/example/docker-compose-trace.yaml -p hugegraph-trace up -d
9697
```
9798

@@ -104,6 +105,7 @@ If you want to customize the preloaded data, please mount the groovy scripts (no
104105
3. Stop Open-Telemetry-Collector
105106

106107
```bash
108+
# Run from the repository root
107109
docker compose -f hugegraph-server/hugegraph-dist/docker/example/docker-compose-trace.yaml -p hugegraph-trace stop
108110
```
109111

hugegraph-store/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ bin/restart-hugegraph-store.sh
129129
2. HugeGraph Store cluster (3+ nodes)
130130
3. Proper configuration pointing Store nodes to PD cluster
131131

132-
See Docker Compose examples in the repository root `../docker/` directory. Single-node quickstart (pre-built images): `../docker/docker-compose.yml`. Single-node dev build (from source): `../docker/docker-compose-dev.yml`. 3-node cluster: `../docker/docker-compose-3pd-3store-3server.yml`. See `../docker/README.md` for the full setup guide.
132+
See Docker Compose examples in the repository root `../docker/` directory. Single-node quickstart (pre-built images): `../docker/docker-compose.yml`. Single-node dev build (from source): `../docker/docker-compose.dev.yml`. 3-node cluster: `../docker/docker-compose-3pd-3store-3server.yml`. See `../docker/README.md` for the full setup guide.
133133

134134
## Configuration Files
135135

0 commit comments

Comments
 (0)