imbajin commented on code in PR #344: URL: https://github.com/apache/incubator-hugegraph-doc/pull/344#discussion_r1547203730
########## content/en/docs/quickstart/hugegraph-server.md: ########## @@ -10,21 +10,28 @@ weight: 1 The Core Module is an implementation of the Tinkerpop interface; The Backend module is used to save the graph data to the data store, currently supported backends include: Memory, Cassandra, ScyllaDB, RocksDB; The API Module provides HTTP Server, which converts Client's HTTP request into a call to Core Module. -> There will be two spellings HugeGraph-Server and HugeGraphServer in the document, and other modules are similar. There is no big difference in the meaning of these two ways of writing, which can be distinguished as follows: `HugeGraph-Server` represents the code of server-related components, `HugeGraphServer` represents the service process. +> There will be two spellings HugeGraph-Server and HugeGraphServer in the document, and other +> modules are similar. There is no big difference in the meaning of these two ways, +> which can be distinguished as follows: `HugeGraph-Server` represents the code of server-related +> components, `HugeGraphServer` represents the service process. ### 2 Dependency for Building/Running #### 2.1 Install Java 11 (JDK 11) -Consider using Java 11 to run `HugeGraph-Server` (also compatible with Java 8 now), and configure by yourself. +Consider using Java 11 to run `HugeGraph-Server` (compatible with Java 8 before 1.5.0), +and configure by yourself. **Be sure to execute the `java -version` command to check the jdk version before reading** +> Note: Using Java8 will lose some security guarantees, we recommend using Java11 in production or +> environments exposed to the public network and enable [Auth authentication](/docs/config/config-authentication/). Review Comment: ```suggestion > Note: Using Java8 will lose some security guarantees, we recommend using Java11 in production or > > environments exposed to the public network and enable [Auth authentication](/docs/config/config-authentication/). ``` ########## content/cn/docs/quickstart/hugegraph-server.md: ########## @@ -10,19 +10,19 @@ HugeGraph-Server 是 HugeGraph 项目的核心部分，包含 Core、Backend、A Core 模块是 Tinkerpop 接口的实现，Backend 模块用于管理数据存储，目前支持的后端包括：Memory、Cassandra、ScyllaDB 以及 RocksDB，API 模块提供 HTTP Server，将 Client 的 HTTP 请求转化为对 Core 的调用。 -> 文档中会大量出现 `HugeGraph-Server` 及 `HugeGraphServer` 这两种写法，其他组件也类似。这两种写法含义上并无大的差异，可以这么区分：`HugeGraph-Server` 表示服务端相关组件代码，`HugeGraphServer` 表示服务进程。 +> 文档中会出现 `HugeGraph-Server` 及 `HugeGraphServer` 这两种写法，其他组件也类似。 +> 这两种写法含义上并明显差异，可以这么区分：`HugeGraph-Server` 表示服务端相关组件代码，`HugeGraphServer` 表示服务进程。 ### 2 依赖 #### 2.1 安装 Java 11 (JDK 11) -请优先考虑在 Java 11 的环境上启动 `HugeGraph-Server`，目前同时保留对 Java 8 的兼容 +请优先考虑在 Java 11 的环境上启动 `HugeGraph-Server`(在 1.5.0 版前，会保留对 Java 8 的基本兼容) -**在往下阅读之前务必执行 `java -version` 命令查看 jdk 版本** +**在往下阅读之前先执行 `java -version` 命令确认 jdk 版本** -```bash -java -version -``` +> 注：使用 Java 8 启动 HugeGraph-Server 会失去一些**安全性**的保障，也会降低性能相关指标 +> 我们推荐生产或对外网暴露访问的环境使用 Java 11 并考虑开启 [Auth 权限认证](/cn/docs/config/config-authentication/)。 Review Comment: ```suggestion > 注：使用 Java 8 启动 HugeGraph-Server 会失去一些**安全性**的保障，也会降低性能相关指标 > > 我们推荐生产或对外网暴露访问的环境使用 Java 11 并考虑开启 [Auth 权限认证](/cn/docs/config/config-authentication/)。 ``` -- 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]
