From 271d72c9f39e83e7374a01ab79be11ccf1149f7d Mon Sep 17 00:00:00 2001 From: imbajin Date: Tue, 28 Feb 2023 00:16:32 +0800 Subject: [PATCH] doc: update issue template & README file (#2131) * doc: update issue template & README file * replace outdated url --- .github/ISSUE_TEMPLATE/bug_report.yml | 32 +++++++++-------- .github/ISSUE_TEMPLATE/config.yml | 8 ++--- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/question_ask.yml | 35 ++++++++++--------- CONTRIBUTING.md | 15 ++++---- README.md | 15 +++++--- .../hugegraph/api/profile/ProfileAPI.java | 5 +-- .../security/HugeSecurityManager.java | 4 +-- .../store/rocksdb/RocksDBStdSessions.java | 2 +- 9 files changed, 65 insertions(+), 53 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 7477defcde..74095d8e6e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -10,18 +10,18 @@ body: value: >- ### Note (特别注意) : - > 1. 请先**搜索**现有的[Issues](https://github.com/hugegraph/hugegraph/issues) 与 - [FAQ](https://hugegraph.github.io/hugegraph-doc/guides/faq.html) 中没有与您相同 + > 1. 请先**搜索**现有的[Issues](https://github.com/apache/hugegraph/issues) 与 + [FAQ](https://hugegraph.apache.org/docs/guides/faq/) 中没有与您相同 / 相关的问题 (请勿重复提交) > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) 会**越快**被响应和处理 - > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰 + > 3. Issue 标题请保留原有分类标签 (例如:`[Bug]`), 长段描述请增加`空行`并使用`序号`标记, 保持排版清晰 > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭** (更新时会再开启) - + - type: dropdown attributes: label: Bug Type (问题类型) @@ -31,36 +31,38 @@ body: - other exception / error (其他异常报错) - server status (启动/运行异常) - logic (逻辑设计问题) - - performence (性能下降) + - performance (性能下降) - others (please edit later) - + - type: checkboxes attributes: label: Before submit options: - - label: 我已经确认现有的 [Issues](https://github.com/hugegraph/hugegraph/issues) 与 [FAQ](https://hugegraph.github.io/hugegraph-doc/guides/faq.html) 中没有相同 / 重复问题 + - label: '我已经确认现有的 [Issues](https://github.com/apache/hugegraph/issues) 与 + [FAQ](https://hugegraph.apache.org/docs/guides/faq/) 中没有相同 / 重复问题 (I have confirmed + and searched that there are no similar problems in the historical issue and documents)' required: true - type: textarea attributes: label: Environment (环境信息) description: | - > server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions) + > server version could get from [rest-api](https://hugegraph.apache.org/docs/clients/restful-api/) (http://localhost:8080/versions) value: | - - Server Version: v0.11.x + - Server Version: 1.0.0 (Apache Release Version) - Backend: RocksDB x nodes, HDD or SSD - - OS: xx CPUs, xx G RAM, Centos 7.x + - OS: xx CPUs, xx G RAM, Ubuntu 2x.x / CentOS 7.x - Data Size: xx vertices, xx edges validations: required: true - + - type: textarea attributes: label: Expected & Actual behavior (期望与实际表现) description: | > we can refer [How to create a minimal reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example) (如何提供最简的可复现用例) - > if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳) - placeholder: | + > if possible, please provide **screenshots** / Pic or `GIF` (请提供清晰的截图, 动图录屏更佳) + placeholder: | type the main problem here ```java @@ -69,7 +71,7 @@ body: ``` validations: required: true - + - type: textarea attributes: label: Vertex/Edge example (问题点 / 边数据举例) @@ -84,7 +86,7 @@ body: "vertex": { "id": "xxx" } } render: javascript - + - type: textarea attributes: label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3fc8d9dead..31f3647471 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,9 +2,9 @@ blank_issues_enabled: false # 设置提 issue 前的参考文档 contact_links: - - name: HugeGraph Server Doc - url: https://hugegraph.github.io/hugegraph-doc/quickstart/hugegraph-server.html + - name: HugeGraph Server Doc (EN/CN) + url: https://hugegraph.apache.org/docs/quickstart/hugegraph-server/ about: Please search question here before opening a new issue - - name: HugeGraph API Doc - url: https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html + - name: HugeGraph API Doc (EN/CN) + url: https://hugegraph.apache.org/docs/clients/ about: Please search usage here before opening a new issue diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 4012606e4a..9897c3f31d 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -10,6 +10,6 @@ body: label: Feature Description (功能描述) description: | > 请简要描述新功能 / 需求的使用场景或上下文, 最好能给个具体的例子说明 - placeholder: type the feature description here + placeholder: type the feature description here validations: required: true diff --git a/.github/ISSUE_TEMPLATE/question_ask.yml b/.github/ISSUE_TEMPLATE/question_ask.yml index 75efff5135..7432f9183a 100644 --- a/.github/ISSUE_TEMPLATE/question_ask.yml +++ b/.github/ISSUE_TEMPLATE/question_ask.yml @@ -8,18 +8,18 @@ body: value: >- ### Note (特别注意) : - > 1. 请先**搜索**现有的[Issues](https://github.com/hugegraph/hugegraph/issues) 与 - [FAQ](https://hugegraph.github.io/hugegraph-doc/guides/faq.html) 中没有与您相同 + > 1. 请先**搜索**现有的[Issues](https://github.com/apache/hugegraph/issues) 与 + [FAQ](https://hugegraph.apache.org/docs/guides/faq/) 中没有与您相同 / 相关的问题 (请勿重复提交) > 2. 我们需要尽可能**详细**的信息来**复现**问题, 越详细的信息 (包括**日志 / 截图 / 配置**等) 会**越快**被响应和处理 - > 3. Issue 标题请保持原有模板分类(例如:`[Bug]`), 长段描述之间可以增加`空行`或使用`序号`标记, 保持排版清晰 + > 3. Issue 标题请保留原有分类标签 (例如:`[Bug]`), 长段描述请增加`空行`并使用`序号`标记, 保持排版清晰 > 4. 请在对应的模块提交 issue, 缺乏有效信息 / 长时间 (> 14 天) 没有回复的 issue 可能会被 **关闭** (更新时会再开启) - + - type: dropdown attributes: label: Problem Type (问题类型) @@ -29,37 +29,40 @@ body: - server status (启动/运行异常) - configs (配置项 / 文档相关) - struct / logic (架构 / 逻辑设计问题) - - performence (性能优化) + - performance (性能优化) - other exception / error (其他异常报错) - others (please edit later) - + - type: checkboxes attributes: label: Before submit options: - - label: 我已经确认现有的 [Issues](https://github.com/hugegraph/hugegraph/issues) 与 [FAQ](https://hugegraph.github.io/hugegraph-doc/guides/faq.html) 中没有相同 / 重复问题 + - label: '我已经确认现有的 [Issues](https://github.com/apache/hugegraph/issues) 与 + [FAQ](https://hugegraph.apache.org/docs/guides/faq/) 中没有相同 / 重复问题 (I have confirmed + and searched that there are no similar problems in the historical issue and documents)' required: true - type: textarea attributes: label: Environment (环境信息) description: | - > server version could get from [rest-api](https://hugegraph.github.io/hugegraph-doc/clients/restful-api/other.html) (http://localhost:8080/versions) + > server version could get from [rest-api](https://hugegraph.apache.org/docs/clients/restful-api/) (http://localhost:8080/versions) value: | - - Server Version: v0.11.x + - Server Version: 1.0.0 (Apache Release Version) - Backend: RocksDB x nodes, HDD or SSD - - OS: xx CPUs, xx G RAM, Centos 7.x + - OS: xx CPUs, xx G RAM, Ubuntu 2x.x / CentOS 7.x - Data Size: xx vertices, xx edges validations: required: true - + - type: textarea attributes: label: Your Question (问题描述) description: | - > 图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.github.io/hugegraph-doc/clients/hugegraph-api.html), 以及 [Server 配置文档](https://hugegraph.github.io/hugegraph-doc/config/config-option.html) - > if possible, please provide screenshots or GIF (请提供清晰的截图, 动图录屏更佳) - placeholder: | + > 图使用 / 配置相关问题，请优先参考 [REST-API 文档](https://hugegraph.apache.org/docs/clients/restful-api/), + > 以及 [Server 配置文档](https://hugegraph.apache.org/docs/config/) + > if possible, please provide **screenshots** / Pic or `GIF` (请提供清晰的截图, 动图录屏更佳) + placeholder: | type the main problem here ```java @@ -68,7 +71,7 @@ body: ``` validations: required: true - + - type: textarea attributes: label: Vertex/Edge example (问题点 / 边数据举例) @@ -83,7 +86,7 @@ body: "vertex": { "id": "xxx" } } render: javascript - + - type: textarea attributes: label: Schema [VertexLabel, EdgeLabel, IndexLabel] (元数据结构) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61d5bd3f08..2ed63e97c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ # How to Contribute to HugeGraph -Thanks for taking the time to contribute! As an open source project, HugeGraph is looking forward to be contributed from everyone, and we are also grateful to all of the contributors. +Thanks for taking the time to contribute! As an open source project, HugeGraph is looking forward to be contributed from everyone, +and we are also grateful to all the contributors. The following is a contribution guide for HugeGraph: @@ -36,7 +37,7 @@ Before submitting the code, we need to do some preparation: git config user.email "{email-address-of-github}" # like "jermy@apache.org" ``` -Optional: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the commit and update process. +**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR process. ## 2. Create an Issue on GitHub @@ -46,7 +47,7 @@ If you encounter bugs or have any questions, please go to [GitHub Issues](https: #### 3.1 Create a new branch -Please don't use master branch for development. Instead we should create a new branch: +Please don't use master branch for development. Instead, we should create a new branch: ```shell # checkout master branch @@ -63,8 +64,8 @@ Assume that we need to modify some files like "HugeGraph.java" and "HugeFactory. ```shell # modify code to fix a bug -vim hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraph.java -vim hugegraph-core/src/main/java/com/baidu/hugegraph/HugeFactory.java +vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java +vim hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java # run test locally (optional) mvn test -Pcore-test,memory ``` @@ -76,8 +77,8 @@ After the code has been completed, we submit them to the local git repo: ```shell # add files to local git index -git add hugegraph-core/src/main/java/com/baidu/hugegraph/HugeGraph.java -git add hugegraph-core/src/main/java/com/baidu/hugegraph/HugeFactory.java +git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeGraph.java +git add hugegraph-core/src/main/java/org/apache/hugegraph/HugeFactory.java # commit to local git repo git commit ``` diff --git a/README.md b/README.md index d0a551f068..fca4095b9c 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,18 @@

- A graph database that supports more than 10+ billion data, high performance and scalability + A graph database that supports more than 10 billion data, high performance and scalability

+# Apache HugeGraph + [![License](https://img.shields.io/badge/license-Apache%202-0E78BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) -[![Build Status](https://github.com/hugegraph/hugegraph/actions/workflows/ci.yml/badge.svg)](https://github.com/hugegraph/hugegraph/actions/workflows/ci.yml) -[![Codecov](https://codecov.io/gh/hugegraph/hugegraph/branch/master/graph/badge.svg)](https://codecov.io/gh/hugegraph/hugegraph) -[![GitHub Releases Downloads](https://img.shields.io/github/downloads/hugegraph/hugegraph/total.svg)](https://github.com/hugegraph/hugegraph/releases) +[![HugeGraph-CI](https://github.com/apache/incubator-hugegraph/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-hugegraph/actions/workflows/ci.yml) +[![CodeQL](https://github.com/apache/incubator-hugegraph/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/apache/incubator-hugegraph/actions/workflows/codeql-analysis.yml) +[![License checker](https://github.com/apache/incubator-hugegraph/actions/workflows/licence-checker.yml/badge.svg)](https://github.com/apache/incubator-hugegraph/actions/workflows/licence-checker.yml) +[![Codecov](https://codecov.io/gh/apache/hugegraph/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/hugegraph) +[![GitHub Releases Downloads](https://img.shields.io/github/downloads/apache/hugegraph/total.svg)](https://github.com/apache/hugegraph/releases) [HugeGraph](https://hugegraph.apache.org/) is a fast-speed and highly-scalable [graph database](https://en.wikipedia.org/wiki/Graph_database). Billions of vertices and edges can be easily stored into and queried from HugeGraph due to its excellent OLTP ability. As compliance to [Apache TinkerPop 3](https://tinkerpop.apache.org/) framework, various complicated graph queries can be accomplished through [Gremlin](https://tinkerpop.apache.org/gremlin.html)(a powerful graph traversal language). @@ -24,7 +28,8 @@ ## Getting Started -The project [homepage](https://hugegraph.apache.org/docs/) contains more information on HugeGraph and provides links to **documentation**, getting-started guides and release downloads. +The project [homepage](https://hugegraph.apache.org/docs/) contains more information on HugeGraph +and provides links to **documentation**, getting-started guides and [Release Download Page](https://hugegraph.apache.org/docs/download/download/) And here are links of other repositories: 1. [hugegraph-toolchain](https://github.com/apache/incubator-hugegraph-toolchain) (include loader/dashboard/tool/client) diff --git a/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/ProfileAPI.java b/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/ProfileAPI.java index f5018244a2..c28b4878bf 100644 --- a/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/ProfileAPI.java +++ b/hugegraph-api/src/main/java/org/apache/hugegraph/api/profile/ProfileAPI.java @@ -44,6 +44,7 @@ import org.apache.hugegraph.util.InsertionOrderUtil; import org.apache.hugegraph.util.JsonUtil; import org.apache.hugegraph.version.CoreVersion; + import com.codahale.metrics.annotation.Timed; @Path("/") @@ -52,8 +53,8 @@ public class ProfileAPI { private static final String SERVICE = "hugegraph"; - private static final String DOC = "https://hugegraph.github.io/hugegraph-doc/"; - private static final String API_DOC = DOC + "clients/hugegraph-api.html"; + private static final String DOC = "https://hugegraph.apache.org/docs/"; + private static final String API_DOC = DOC + "clients/"; private static String SERVER_PROFILES = null; private static String API_PROFILES = null; diff --git a/hugegraph-core/src/main/java/org/apache/hugegraph/security/HugeSecurityManager.java b/hugegraph-core/src/main/java/org/apache/hugegraph/security/HugeSecurityManager.java index 0db3f63ce8..af168a53b5 100644 --- a/hugegraph-core/src/main/java/org/apache/hugegraph/security/HugeSecurityManager.java +++ b/hugegraph-core/src/main/java/org/apache/hugegraph/security/HugeSecurityManager.java @@ -73,7 +73,7 @@ public class HugeSecurityManager extends SecurityManager { ); private static final Map> ASYNC_TASKS = ImmutableMap.of( - // Fixed https://github.com/hugegraph/hugegraph/pull/892#issue-387202362 + // Fixed https://github.com/apache/hugegraph/pull/892#issue-387202362 "org.apache.hugegraph.backend.tx.SchemaTransaction", ImmutableSet.of("removeVertexLabel", "removeEdgeLabel", "removeIndexLabel", "rebuildIndex"), @@ -91,7 +91,7 @@ public class HugeSecurityManager extends SecurityManager { // Fixed #758 "org.apache.hugegraph.backend.store.cassandra.CassandraStore", ImmutableSet.of("open", "opened", "init"), - // Fixed https://github.com/hugegraph/hugegraph/pull/892#issuecomment-598545072 + // Fixed https://github.com/apache/hugegraph/pull/892#issuecomment-598545072 "com.datastax.driver.core.AbstractSession", ImmutableSet.of("execute") ); diff --git a/hugegraph-rocksdb/src/main/java/org/apache/hugegraph/backend/store/rocksdb/RocksDBStdSessions.java b/hugegraph-rocksdb/src/main/java/org/apache/hugegraph/backend/store/rocksdb/RocksDBStdSessions.java index c0127e0c5c..71a66906dd 100644 --- a/hugegraph-rocksdb/src/main/java/org/apache/hugegraph/backend/store/rocksdb/RocksDBStdSessions.java +++ b/hugegraph-rocksdb/src/main/java/org/apache/hugegraph/backend/store/rocksdb/RocksDBStdSessions.java @@ -173,7 +173,7 @@ public synchronized void dropTable(String... tables) /* * May cause bug to drop CF when someone is reading or writing this CF, * use CFHandle to wait for others and then do drop: - * https://github.com/hugegraph/hugegraph/issues/697 + * https://github.com/apache/hugegraph/issues/697 */ List cfhs = new ArrayList<>(); for (String table : tables) {