imbajin commented on code in PR #2965: URL: https://github.com/apache/hugegraph/pull/2965#discussion_r2930174439
########## CONTRIBUTING.md: ########## @@ -75,10 +75,10 @@ Note: Code style is defined by the `.editorconfig` file at the repository root. ##### 3.2.1 Check licenses If we want to add new third-party dependencies to the `HugeGraph` project, we need to do the following things: -1. Find the third-party dependent repository, put the dependent `license` file into [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/incubator-hugegraph/tree/master/hugegraph-dist/release-docs/licenses) path. -2. Declare the dependency in [./install-dist/release-docs/LICENSE](https://github.com/apache/incubator-hugegraph/blob/master/install-dist/release-docs/LICENSE) `LICENSE` information. -3. Find the NOTICE file in the repository and append it to [./install-dist/release-docs/NOTICE](https://github.com/apache/incubator-hugegraph/blob/master/install-dist/release-docs/NOTICE) file (skip this step if there is no NOTICE file). -4. Execute locally [./install-dist/scripts/dependency/regenerate_known_dependencies.sh](https://github.com/apache/incubator-hugegraph/blob/master/install-dist/scripts/dependency/regenerate_known_dependencies.sh) to update the dependency list [known-dependencies.txt](https://github.com/apache/incubator-hugegraph/blob/master/install-dist/scripts/dependency/known-dependencies.txt) (or manually update). +1. Find the third-party dependent repository, put the dependent `license` file into [./hugegraph-dist/release-docs/licenses/](https://github.com/apache/hugegraph/tree/master/hugegraph-dist/release-docs/licenses) path. Review Comment: ⚠️ 这里的链接仍然指向 `hugegraph-dist/release-docs/licenses`，但 PR head 上这个路径已经是 404，仓库里实际存在的是 `install-dist/release-docs/licenses`。现在读者按文档点击会直接走到不存在的目录，建议把文案和链接一起改到真实路径。 ```suggestion 1. Find the third-party dependent repository, put the dependent `license` file into [./install-dist/release-docs/licenses/](https://github.com/apache/hugegraph/tree/master/install-dist/release-docs/licenses) path. ``` ########## README.md: ########## @@ -223,9 +223,9 @@ Download pre-built packages from the [Download Page](https://hugegraph.apache.or ```bash # Download and extract -wget https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-incubating-{version}.tar.gz -tar -xzf apache-hugegraph-incubating-{version}.tar.gz -cd apache-hugegraph-incubating-{version} +wget https://downloads.apache.org/hugegraph/{version}/apache-hugegraph-{version}.tar.gz Review Comment: ⚠️ 我实际验证了当前 `downloads.apache.org/hugegraph/1.7.0/` 和 `archive.apache.org/dist/hugegraph/1.7.0/`，其中存在的仍然是 `apache-hugegraph-incubating-1.7.0.tar.gz`，这里改成无 `-incubating` 后按示例执行会 404。除非这个 PR 会同步发布新的无 `-incubating` 1.7.0 工件，否则建议先保留当前已发布文件名，或者改成引导用户从下载页选择版本，而不是硬编码一个暂时不存在的文件名。 ```suggestion wget https://downloads.apache.org/hugegraph/{version}/apache-hugegraph-incubating-{version}.tar.gz tar -xzf apache-hugegraph-incubating-{version}.tar.gz cd apache-hugegraph-incubating-{version} ``` ########## hugegraph-store/docs/deployment-guide.md: ########## @@ -416,8 +416,8 @@ df -h ```bash # Extract PD distribution -tar -xzf apache-hugegraph-pd-incubating-1.7.0.tar.gz -cd apache-hugegraph-pd-incubating-1.7.0 +tar -xzf apache-hugegraph-pd-1.7.0.tar.gz Review Comment: ⚠️ 这组 1.7.0 示例命令和上面的 README 是同一个问题：我确认过 Apache 下载站当前公开的 1.7.0 文件名仍然是 `apache-hugegraph-pd-incubating-1.7.0.tar.gz`。现在这里改成无 `-incubating` 后，读者照着执行会直接找不到包；下一行 `cd` 进去的目录名也会随之不匹配。建议在新的正式发布工件真正上线之前，先保持和现有 1.7.0 发布物一致。 ```suggestion tar -xzf apache-hugegraph-pd-incubating-1.7.0.tar.gz cd apache-hugegraph-pd-incubating-1.7.0 ``` ########## hugegraph-store/docs/deployment-guide.md: ########## @@ -509,8 +509,8 @@ curl http://192.168.1.10:8620/v1/members ```bash # Extract Store distribution -tar -xzf apache-hugegraph-store-incubating-1.7.0.tar.gz -cd apache-hugegraph-store-incubating-1.7.0 +tar -xzf apache-hugegraph-store-1.7.0.tar.gz Review Comment: ⚠️ 这里同样会把当前 1.7.0 用户带向一个不存在的发布文件。Apache 下载站上现有的 Store 产物仍然是 `apache-hugegraph-store-incubating-1.7.0.tar.gz`，所以这行 `tar` 和下一行 `cd` 在现阶段都会失败。建议这个文档示例先保持和已发布工件一致，或者显式说明这里只适用于后续无 `-incubating` 的新版本。 ```suggestion tar -xzf apache-hugegraph-store-incubating-1.7.0.tar.gz cd apache-hugegraph-store-incubating-1.7.0 ``` ########## hugegraph-store/docs/deployment-guide.md: ########## @@ -626,8 +626,8 @@ curl http://192.168.1.10:8620/v1/stores ```bash # Extract Server distribution -tar -xzf apache-hugegraph-incubating-1.7.0.tar.gz -cd apache-hugegraph-incubating-1.7.0 +tar -xzf apache-hugegraph-1.7.0.tar.gz Review Comment: ⚠️ Server 这段也有同样的问题：当前 Apache 下载站 1.7.0 目录里实际存在的是 `apache-hugegraph-incubating-1.7.0.tar.gz`，不是这里的无 `-incubating` 名称。按现有示例执行会在解压和进入目录两个步骤都失败，建议和现网已发布文件名保持一致，或者把示例改成不硬编码当前还不存在的 1.7.0 文件名。 ```suggestion tar -xzf apache-hugegraph-incubating-1.7.0.tar.gz cd apache-hugegraph-incubating-1.7.0 ``` -- 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]
