imbajin commented on code in PR #455:
URL: https://github.com/apache/hugegraph-doc/pull/455#discussion_r2992687047
##########
content/en/docs/quickstart/hugegraph/hugegraph-hstore.md:
##########
@@ -39,7 +39,6 @@ cd
apache-hugegraph-incubating-{version}/apache-hugegraph-hstore-incubating-{ver
```bash
# 1. Clone the source code
Review Comment:
‼️ The source-build snippet says `# 1. Clone the source code`, but the
actual `git clone ...` command was removed, so the later `cd hugegraph` and
`mvn ...` steps are no longer runnable as written. Please restore the clone
command or change the text to make the pre-cloned assumption explicit.
```suggestion
git clone https://github.com/apache/hugegraph.git
```
##########
content/en/docs/guides/hugegraph-docker-cluster.md:
##########
@@ -0,0 +1,133 @@
+---
+title: "HugeGraph Docker Cluster Guide"
+linkTitle: "Docker Cluster"
+weight: 5
+---
+
+## Overview
+
+HugeGraph supports running a full distributed cluster (PD + Store + Server)
via Docker using bridge networking. This works on Linux and Mac (Docker
Desktop).
+
+Previous versions used `network_mode: host` which only worked on Linux. The
cluster now uses a Docker bridge network (`hg-net`) where services communicate
via container hostnames instead of `127.0.0.1`.
+
+## Prerequisites
+
+- Docker Engine 20.10+ or Docker Desktop 4.x+
+- Docker Compose v2
+- For the 3-node cluster: at least **12 GB** memory allocated to Docker
Desktop (Settings → Resources → Memory)
+
+> **Tested platforms**: Linux (native Docker) and macOS (Docker Desktop,
tested on Apple M4). Windows Docker Desktop is untested.
+
+## Compose Files
+
+Three compose files are available in the
[`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory:
+
+| File | Description |
+|------|-------------|
+| `docker-compose.yml` | Single-node quickstart using pre-built images |
+| `docker-compose-dev.yml` | Single-node dev build from source |
Review Comment:
‼️ `docker-compose-dev.yml` does not exist in `apache/hugegraph/docker`; the
repo uses `docker-compose.dev.yml` (dot, not dash). Readers copying this path
will hit a missing-file error.
```suggestion
| `docker-compose.dev.yml` | Single-node dev build from source |
```
##########
content/en/docs/quickstart/hugegraph/hugegraph-pd.md:
##########
@@ -38,7 +38,6 @@ cd
apache-hugegraph-incubating-{version}/apache-hugegraph-pd-incubating-{version
```bash
# 1. Clone the source code
Review Comment:
‼️ The source-build snippet says `# 1. Clone the source code`, but the
actual `git clone ...` command was removed, so step 2 now assumes a checkout
that the reader was never told to create. Please restore the clone command or
rewrite the step to say the repo is already cloned.
```suggestion
git clone https://github.com/apache/hugegraph.git
```
##########
content/en/docs/quickstart/hugegraph/hugegraph-server.md:
##########
@@ -56,23 +56,23 @@ If you use docker desktop, you can set the option like:
<img src="/docs/images/images-server/31docker-option.jpg" alt="image"
style="width:33%;">
</div>
-Also, if we want to manage the other Hugegraph related instances in one file,
we can use `docker-compose` to deploy, with the command `docker-compose up -d`
(you can config only `server`). Here is an example `docker-compose.yml`:
+> **Note**: The Docker compose files use bridge networking (`hg-net`) and work
on Linux and Mac (Docker Desktop). For the 3-node distributed cluster, allocate
at least **12 GB** memory to Docker Desktop (Settings → Resources → Memory).
-```yaml
-version: '3'
-services:
- server:
- image: hugegraph/hugegraph:1.7.0
- container_name: server
- environment:
- - PASSWORD=xxx
- # PASSWORD is an option to enable auth mode with the password you set.
- # - PRELOAD=true
- # PRELOAD is a option to preload a build-in sample graph when initializing.
- ports:
- - 8080:8080
+Also, if we want to manage HugeGraph-related instances in one file, we can use
`docker compose` to deploy.
+Two compose files are available in the
[`docker/`](https://github.com/apache/hugegraph/tree/master/docker) directory:
+
+- **Single-node quickstart** (pre-built images): `docker/docker-compose.yml`
+- **Single-node dev build** (build from source):
`docker/docker-compose-dev.yml`
Review Comment:
‼️ This bullet points readers to `docker/docker-compose-dev.yml`, but the
actual file in the repo is `docker/docker-compose.dev.yml`. The wrong filename
will make the suggested quickstart fail immediately.
```suggestion
- **Single-node dev build** (build from source):
`docker/docker-compose.dev.yml`
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
