You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hugegraph.apache.org by ji...@apache.org on 2023/02/26 14:40:23 UTC
[incubator-hugegraph] 01/01: doc: update issue template & README file
This is an automated email from the ASF dual-hosted git repository.
jin pushed a commit to branch update-issue
in repository https://gitbox.apache.org/repos/asf/incubator-hugegraph.git
commit 930c3521284cbcbe0ed4cbcdfc5e4cb1867d0daa
Author: imbajin <ji...@apache.org>
AuthorDate: Sun Feb 26 22:40:15 2023 +0800
doc: update issue template & README file
---
.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 ++++++++++++++++--------------
README.md | 15 ++++++++-----
5 files changed, 51 insertions(+), 41 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 7477defcd..74095d8e6 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 <!-- (like 1000W 点, 9000W 边) -->
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 3fc8d9dea..31f364747 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 4012606e4..9897c3f31 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 75efff513..7432f9183 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 <!-- (like 1000W 点, 9000W 边) -->
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/README.md b/README.md
index d0a551f06..fca4095b9 100644
--- a/README.md
+++ b/README.md
@@ -3,14 +3,18 @@
</div>
<p align="center">
- 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
</p>
<hr/>
+# Apache HugeGraph
+
[](https://www.apache.org/licenses/LICENSE-2.0.html)
-[](https://github.com/hugegraph/hugegraph/actions/workflows/ci.yml)
-[](https://codecov.io/gh/hugegraph/hugegraph)
-[](https://github.com/hugegraph/hugegraph/releases)
+[](https://github.com/apache/incubator-hugegraph/actions/workflows/ci.yml)
+[](https://github.com/apache/incubator-hugegraph/actions/workflows/codeql-analysis.yml)
+[](https://github.com/apache/incubator-hugegraph/actions/workflows/licence-checker.yml)
+[](https://codecov.io/gh/apache/hugegraph)
+[](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)