Skip to content

Commit

Permalink
add mail template when validate the release & fix outdated url (#177)
Browse files Browse the repository at this point in the history
* add mail template when validate the release

* Update validate-release.md

* update a string of links
  • Loading branch information
imbajin committed Jan 4, 2023
1 parent b3fd514 commit 4980820
Show file tree
Hide file tree
Showing 17 changed files with 131 additions and 58 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ jobs:
PERSONAL_ACCESS_TOKEN : ${{ secrets.PERSONAL_ACCESS_TOKEN }}
with:
path-to-signatures: '.github/cla-signatures/cla.json'
path-to-document: 'https://github.com/hugegraph/hugegraph-doc/blob/master/CLA.md' # e.g. a CLA or a DCO document
custom-allsigned-prcomment: '**Good**! All Contributors have signed the [CLA](https://github.com/hugegraph/hugegraph-doc/blob/master/CLA.md).'
path-to-document: 'https://github.com/apache/hugegraph-doc/blob/master/CLA.md' # e.g. a CLA or a DCO document
custom-allsigned-prcomment: '**Good**! All Contributors have signed the [CLA](https://github.com/apache/hugegraph-doc/blob/master/CLA.md).'
# branch should not be protected
branch: 'cla-assist'
allowlist: bot*
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Please visit the [contribution doc](./contribution.md) to get start, include the

### Summary

HugeGraph is an easy-to-use, efficient, general-purpose open source graph database system(Graph Database, [GitHub project address](https://github.com/hugegraph/hugegraph)),
HugeGraph is an easy-to-use, efficient, general-purpose open source graph database system(Graph Database, [GitHub project address](https://github.com/apache/hugegraph)),
implemented the [Apache TinkerPop3](https://tinkerpop.apache.org) framework and is fully compatible with the [Gremlin](https://tinkerpop.apache.org/gremlin.html) query language,
With complete toolchain components, it helps users to easily build applications and products based on graph databases. HugeGraph supports fast import of more than 10 billion vertices and edges, and provides millisecond-level relational query capability (OLTP).
It supports large-scale distributed graph processing (OLAP).
Expand Down
6 changes: 3 additions & 3 deletions content/cn/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h1 ><span style="font-size:50px;font-weight:bold">Apache</span>
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="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/hugegraph/hugegraph">
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="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/apache/hugegraph">
Download <i class="fab fa-github ml-2 "></i>
</a>
<p class="lead mt-5">HugeGraph是一款易用、高效、通用的图数据库</p>
Expand Down Expand Up @@ -67,8 +67,8 @@ <h1 class="text-center">Apache 的第一个图数据库项目</h1>
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="参与开源" url="https://github.com/hugegraph/hugegraph" %}}
我们可以在 **Github** 上提交 [Pull Request](https://github.com/hugegraph/hugegraph/pulls). 热烈欢迎大家加入!
{{% blocks/feature icon="fab fa-github" title="参与开源" url="https://github.com/apache/hugegraph" %}}
我们可以在 **Github** 上提交 [Pull Request](https://github.com/apache/hugegraph/pulls). 热烈欢迎大家加入!
{{% /blocks/feature %}}


Expand Down
14 changes: 7 additions & 7 deletions content/cn/docs/contribution-guidelines/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before submitting the code, we need to do some preparation:

1. Sign up or login to GitHub: [https://github.com](https://github.com)

2. Fork HugeGraph repo from GitHub: [https://github.com/apache/incubator-hugegraph/fork](https://github.com/hugegraph/hugegraph/fork)
2. Fork HugeGraph repo from GitHub: [https://github.com/apache/incubator-hugegraph/fork](https://github.com/apache/hugegraph/fork)

3. Clone code from fork repo to local: [https://github.com/${GITHUB_USER_NAME}/hugegraph](https://github.com/${GITHUB_USER_NAME}/hugegraph)

Expand All @@ -35,7 +35,7 @@ Before submitting the code, we need to do some preparation:
cd hugegraph

# add upstream to synchronize the latest code
git remote add hugegraph https://github.com/hugegraph/hugegraph
git remote add hugegraph https://github.com/apache/hugegraph

# set name and email to push code to github
git config user.name "{full-name}" # like "Jermy Li"
Expand All @@ -46,7 +46,7 @@ Optional: You can use [GitHub desktop](https://desktop.github.com/) to greatly s

## 2. Create an Issue on GitHub

If you encounter bugs or have any questions, please go to [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues) to report them and feel free to [create an issue](https://github.com/hugegraph/hugegraph/issues/new).
If you encounter bugs or have any questions, please go to [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues) to report them and feel free to [create an issue](https://github.com/apache/hugegraph/issues/new).

## 3. Make changes of code locally

Expand All @@ -69,8 +69,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
```
Expand All @@ -82,8 +82,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
```
Expand Down
29 changes: 29 additions & 0 deletions content/cn/docs/contribution-guidelines/validate-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ linkTitle: "验证 Apache 发版"
weight: 3
---

> Note: 这篇文档会持续更新。
## 验证阶段

当内部的临时发布和打包工作完成后, 其他的社区开发者(尤其是 PMC)需要参与到[验证环节](https://cwiki.apache.org/confluence/display/INCUBATOR/Incubator+Release+Checklist)确保某个人发布版本的"正确性 + 完整性", 这里需要**每个人**都尽量参与, 然后后序**邮件回复**的时候说明自己**已检查**了哪些项. (下面是核心项)
Expand Down Expand Up @@ -136,3 +138,30 @@ bin/start-computer.sh -d local -r master
1. 确保官网至少满足 [apache website check](https://whimsy.apache.org/pods/project/hugegraph), 以及没有死链等
2. 更新**下载链接**以及版本更新说明
3. ...

## 邮件模板

检查完成后, 你应该按不同角色回复邮件: (普通开发者 & PMC 成员)

```markdown
+1 (non-binding)
I checked:
1. All download links are valid
2. Checksum and signature are OK
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5. ....
```

特别注意 PMC 成员必须使用 `binding` 标记回复邮件, 这对于统计有效投票很重要;

```markdown
+1 (binding)
I checked:
1. All download links are valid
2. Checksum and signature are OK
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5. ....
```

2 changes: 1 addition & 1 deletion content/cn/docs/guides/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,4 @@ weight: 5

请求头中需要指定`Content-Type:application/json`

其他问题可以在对应项目的 issue 区搜索,例如 [Server-Issues](https://github.com/hugegraph/hugegraph/issues) / [Loader Issues](https://github.com/hugegraph/hugegraph-loader/issues)
其他问题可以在对应项目的 issue 区搜索,例如 [Server-Issues](https://github.com/apache/hugegraph/issues) / [Loader Issues](https://github.com/apache/hugegraph-toolchain/issues)
2 changes: 1 addition & 1 deletion content/cn/docs/introduction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 1

### Summary

HugeGraph是一款易用、高效、通用的开源图数据库系统(Graph Database,[GitHub项目地址](https://github.com/hugegraph/hugegraph)),
HugeGraph是一款易用、高效、通用的开源图数据库系统(Graph Database,[GitHub项目地址](https://github.com/apache/hugegraph)),
实现了[Apache TinkerPop3](https://tinkerpop.apache.org)框架及完全兼容[Gremlin](https://tinkerpop.apache.org/gremlin.html)查询语言,
具备完善的工具链组件,助力用户轻松构建基于图数据库之上的应用和产品。HugeGraph支持百亿以上的顶点和边快速导入,并提供毫秒级的关联关系查询能力(OLTP),
并支持大规模分布式图分析(OLAP)。
Expand Down
12 changes: 8 additions & 4 deletions content/cn/docs/quickstart/hugegraph-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,23 @@ HugeGraph-Loader 是 HugeGraph 的数据导入组件,能够将多种数据源

#### 2.1 下载已编译的压缩包

下载最新版本的 HugeGraph-Loader release 包:
下载最新版本的 HugeGraph-Toolchain Release 包, 里面包含了 loader + tool + hubble 全套工具, 如果你已经下载, 可跳过重复步骤

```bash
wget https://github.com/hugegraph/hugegraph-loader/releases/download/v${version}/hugegraph-loader-${version}.tar.gz
tar zxvf hugegraph-loader-${version}.tar.gz
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
tar zxf *hugegraph*.tar.gz
```

#### 2.2 克隆源码编译安装

克隆最新版本的 HugeGraph-Loader 源码包:

```bash
$ git clone https://github.com/hugegraph/hugegraph-loader.git
# 1. get from github
git clone https://github.com/apache/hugegraph-toolchain.git

# 2. get from direct (e.g. here is 1.0.0, please choose the latest version)
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0-src.tar.gz
```

由于Oracle ojdbc license的限制,需要手动安装ojdbc到本地maven仓库。
Expand Down
19 changes: 11 additions & 8 deletions content/cn/docs/quickstart/hugegraph-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,15 @@ gcc --version

#### 3.1 一键部署

HugeGraph-Tools提供了一键部署的命令行工具,用户可以使用该工具快速地一键下载、解压、配置并启动HugeGraphServer和HugeGraphStudio。
当然,还是得先下载HugeGraph-Tools的tar包。
HugeGraph-Tools 提供了一键部署的命令行工具,用户可以使用该工具快速地一键下载、解压、配置并启动 HugeGraph-Server 和 HugeGraph-Hubble
最新的 HugeGraph-Toolchain 中已经包含所有的这些工具, 直接下载它解压就有工具包集合了

```bash
wget https://github.com/hugegraph/hugegraph-tools/releases/download/v${version}/hugegraph-tools-${version}.tar.gz
tar -zxvf hugegraph-tools-${version}.tar.gz
cd hugegraph-tools-${version}
# download toolchain package, it includes loader + tool + hubble, please check the latest version (here is 1.0.0)
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
tar zxf *hugegraph-*.tar.gz
# enter the tool's package
cd *hugegraph*/*tool*
```

> 注:${version}为版本号,最新版本号可参考[Download页面](/docs/download/download),或直接从Download页面点击链接下载
Expand All @@ -64,16 +66,17 @@ bin/hugegraph deploy -v {hugegraph-version} -p {install-path} [-u {download-path
#### 3.2 下载tar包

```bash
wget https://github.com/hugegraph/hugegraph/releases/download/v${version}/hugegraph-${version}.tar.gz
tar -zxvf hugegraph-${version}.tar.gz
# use the latest version, here is 1.0.0 for example
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-incubating-1.0.0.tar.gz
tar zxf *hugegraph*.tar.gz
```

#### 3.3 源码编译

下载HugeGraph源代码

```bash
git clone https://github.com/hugegraph/hugegraph.git
git clone https://github.com/apache/hugegraph.git
```

编译打包生成tar包
Expand Down
16 changes: 10 additions & 6 deletions content/cn/docs/quickstart/hugegraph-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,30 @@ HugeGraph-Tools 是 HugeGraph 的自动化部署、管理和备份/还原组件

### 2 获取 HugeGraph-Tools

有两种方式可以获取 HugeGraph-Tools:
有两种方式可以获取 HugeGraph-Tools:(它被包含子 Toolchain 中)

- 下载二进制tar包
- 下载源码编译安装

#### 2.1 下载二进制tar包

下载最新版本的 HugeGraph-Tools 包:
下载最新版本的 HugeGraph-Toolchain 包, 然后进入 tools 子目录

```bash
wget https://github.com/hugegraph/hugegraph-tools/releases/download/v${version}/hugegraph-tools-${version}.tar.gz
tar zxvf hugegraph-tools-${version}.tar.gz
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
tar zxf *hugegraph*.tar.gz
```

#### 2.2 下载源码编译安装

下载最新版本的 HugeGraph-Tools 源码包:
下载最新版本的 HugeGraph-Toolchain 源码包, 然后根目录编译或者单独编译 tool 子模块

```bash
$ git clone https://github.com/hugegraph/hugegraph-tools.git
# 1. get from github
git clone https://github.com/apache/hugegraph-toolchain.git

# 2. get from direct (e.g. here is 1.0.0, please choose the latest version)
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0-src.tar.gz
```

编译生成 tar 包:
Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/scripts/github-deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
set -x
# this script is for developers to manually deploy doc to GitHub Pages
REMOTE="github"
REMOTE_URL="https://github.com/hugegraph/hugegraph-doc"
REMOTE_URL="https://github.com/apache/hugegraph-doc"
REPO="hugegraph-doc"
BRANCH_BUILD="master"
BRANCH_PAGES="gh-pages"
Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/contribution-guidelines/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before submitting the code, we need to do some preparation:

1. Sign up or login to GitHub: [https://github.com](https://github.com)

2. Fork HugeGraph repo from GitHub: [https://github.com/apache/incubator-hugegraph/fork](https://github.com/hugegraph/hugegraph/fork)
2. Fork HugeGraph repo from GitHub: [https://github.com/apache/incubator-hugegraph/fork](https://github.com/apache/hugegraph/fork)

3. Clone code from fork repo to local: [https://github.com/${GITHUB_USER_NAME}/hugegraph](https://github.com/${GITHUB_USER_NAME}/hugegraph)

Expand All @@ -33,7 +33,7 @@ Before submitting the code, we need to do some preparation:
cd hugegraph

# add upstream to synchronize the latest code
git remote add hugegraph https://github.com/hugegraph/hugegraph
git remote add hugegraph https://github.com/apache/hugegraph

# set name and email to push code to github
git config user.name "{full-name}" # like "Jermy Li"
Expand All @@ -44,7 +44,7 @@ Optional: You can use [GitHub desktop](https://desktop.github.com/) to greatly s

## 2. Create an Issue on GitHub

If you encounter bugs or have any questions, please go to [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues) to report them and feel free to [create an issue](https://github.com/hugegraph/hugegraph/issues/new).
If you encounter bugs or have any questions, please go to [GitHub Issues](https://github.com/apache/incubator-hugegraph/issues) to report them and feel free to [create an issue](https://github.com/apache/hugegraph/issues/new).

## 3. Make changes of code locally

Expand All @@ -67,8 +67,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
```
Expand All @@ -80,8 +80,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
```
Expand Down
27 changes: 26 additions & 1 deletion content/en/docs/contribution-guidelines/validate-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ linkTitle: "Validate Apache Release"
weight: 3
---

> TODO: enhance this doc soon
> Note: this doc will be updated continuously.
## Verification

Expand Down Expand Up @@ -137,3 +137,28 @@ more reference official website: https://hugegraph.apache.org/cn/docs/quickstart
1. Make sure that the official website at least meets [apache website check](https://whimsy.apache.org/pods/project/hugegraph), and no circular links etc.
2. Update **download link** and version update instructions
3. ...

## Mail Template

After the check & test, you should reply the mail with the following content: (normal devs & PMC)
```markdown
+1 (non-binding)
I checked:
1. All download links are valid
2. Checksum and signature are OK
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5. ....
```

and the PMC members should reply with `binding`, it's important for summary the valid votes:
```markdown
+1 (binding)
I checked:
1. All download links are valid
2. Checksum and signature are OK
3. LICENSE and NOTICE are exist
4. Build successfully on macOS(Big Sur)
5. ....
```

8 changes: 4 additions & 4 deletions content/en/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,19 @@ For Gremlin tasks that need to traverse the whole graph, index creation and reco

The module usage process of the platform is as follows:

<center>
<div style="text-align: center;">
<img src="/docs/images/images-hubble/2平台使用流程.png" alt="image">
</center>
</div>


### 3 Platform Instructions
#### 3.1 Graph Management
##### 3.1.1 Graph creation
Under the graph management module, click [Create graph], and realize the connection of multiple graphs by filling in the graph ID, graph name, host name, port number, username, and password information.

<center>
<div style="text-align: center;">
<img src="/docs/images/images-hubble/311图创建.png" alt="image">
</center>
</div>


Create graph by filling in the content as follows::
Expand Down
12 changes: 8 additions & 4 deletions content/en/docs/quickstart/hugegraph-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,23 @@ There are two ways to get HugeGraph-Loader:

#### 2.1 Download the compiled archive

Download the latest version of the HugeGraph-Loader release package:
Download the latest version of the HugeGraph-Toolchain release package:

```bash
wget https://github.com/hugegraph/hugegraph-loader/releases/download/v${version}/hugegraph-loader-${version}.tar.gz
tar zxvf hugegraph-loader-${version}.tar.gz
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
tar zxf *hugegraph*.tar.gz
```

#### 2.2 Clone source code to compile and install

Clone the latest version of HugeGraph-Loader source package:

```bash
$ git clone https://github.com/hugegraph/hugegraph-loader.git
# 1. get from github
git clone https://github.com/apache/hugegraph-toolchain.git

# 2. get from direct (e.g. here is 1.0.0, please choose the latest version)
wget https://dist.apache.org/repos/dist/dev/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0-src.tar.gz
```

Due to the license limitation of the `Oracle OJDBC`, you need to manually install ojdbc to the local maven repository.
Expand Down
Loading

0 comments on commit 4980820

Please sign in to comment.