imbajin commented on code in PR #2390: URL: https://github.com/apache/incubator-hugegraph/pull/2390#discussion_r1428843939
########## README.md: ########## @@ -62,6 +50,16 @@ And here are links of other **HugeGraph** component/repositories: 3. [hugegraph-commons](https://github.com/apache/incubator-hugegraph-commons) (**common & rpc** libs) 4. [hugegraph-website](https://github.com/apache/incubator-hugegraph-doc) (**doc & website** code) +### 3. Docker Way Review Comment: ```suggestion ### 3. Docker Way (Convenient) ``` ########## README.md: ########## @@ -62,6 +50,16 @@ And here are links of other **HugeGraph** component/repositories: 3. [hugegraph-commons](https://github.com/apache/incubator-hugegraph-commons) (**common & rpc** libs) 4. [hugegraph-website](https://github.com/apache/incubator-hugegraph-doc) (**doc & website** code) +### 3. Docker Way + +> Note: The docker image of hugegraph is a convenience release, not official distribution artifacts from ASF. You can find more details from [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub). + +> Note: Recommand to use `release tag`(like `1.0.0`) for the stable version. Use `latest` tag to experience the newest functions in development. Review Comment: put them after #L61 (line 61) and use the format > Note: > 1. xx > 2. ########## README.md: ########## @@ -27,28 +24,19 @@ Billions of vertices and edges can be easily stored into and queried from HugeGr - Compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/), support [Gremlin](https://tinkerpop.apache.org/gremlin.html) & [Cypher](https://en.wikipedia.org/wiki/Cypher) language - Schema Metadata Management, including VertexLabel, EdgeLabel, PropertyKey and IndexLabel - Multi-type Indexes, supporting exact query, range query and complex conditions combination query -- Plug-in Backend Store Driver Framework, support `RocksDB`, `Cassandra`, `HBase`, `ScyllaDB`, and `MySQL/Postgre` now and easy to add other backend store driver if needed +- Plug-in Backend Store Driver Framework, support `RocksDB`, `Cassandra`, `HBase`, `ScyllaDB`, and `MySQL/Postgre` now and easy to add another backend store driver if needed - Integration with `Flink/Spark/HDFS`, and friendly to connect other big data platforms ## Quick Start -### 1. Docker Way -We can use `docker run -itd --name=graph -p 8080:8080 hugegraph/hugegraph` to quickly start an inner -HugeGraph server with `RocksDB` in background. - -Optional: - -1. use `docker exec -it graph bash` to enter the container to do some operations. -2. use `docker run -itd --name=graph -p 8080:8080 -e PRELOAD="true" hugegraph/hugegraph` to start with a **built-in** (example) graph. - -### 2. Download Way +### 1. Download Way Visit [Download Page](https://hugegraph.apache.org/docs/download/download/) and refer the [doc](https://hugegraph.apache.org/docs/quickstart/hugegraph-server/#33-source-code-compilation) Review Comment: seems the refer doc is not for binary release? ########## hugegraph-server/hugegraph-dist/pom.xml: ########## @@ -293,22 +293,6 @@ <include name="${final.name}/**"/> </tarfileset> </tar> - <!-- copy the artifacts to root - directory for better user experience --> - <!-- REMOVE ME after revision 1.5.0 --> - <exec executable="cp" - dir="${project.basedir}" - failonerror="false"> - <arg value="-r"/> - <arg value="../${final.name}"/> - <arg value="../../${final.name}"/> - </exec> - <exec executable="cp" - dir="${project.basedir}" - failonerror="false"> - <arg value="../${final.name}.tar.gz"/> - <arg value="../../${final.name}.tar.gz"/> - </exec> Review Comment: due to we already have the release script in `dist` module, we don't need cp the pkg now ########## hugegraph-server/hugegraph-dist/README.md: ########## Review Comment: maybe we could move it under docker dir (keep it) & link it in README (docker way section) -- 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]
