Skip to content

Commit

Permalink
docs: update for 3.8.0 && docs polishment (#158)
Browse files Browse the repository at this point in the history 
* docs: update for 3.8.0 && docs polishment

* remove invalid badge
  • Loading branch information
@wey-gu
wey-gu authored May 23, 2024
1 parent 7b916e6 commit 1f41987
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 35 deletions.
37 changes: 17 additions & 20 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@
<br>A distributed, scalable, lightning-fast graph database<br>
</p>
<p align="center">
<a href="https://github.com/vesoft-inc/nebula-graph/actions?workflow=docker">
<img src="https://github.com/vesoft-inc/nebula-graph/workflows/docker/badge.svg" alt="build docker image workflow"/>
</a>
<a href="http://githubbadges.com/star.svg?user=vesoft-inc&repo=nebula&style=default">
<img src="https://img.shields.io/github/stars/vesoft-inc/nebula" alt="GitHub stars" />
</a>
Expand All @@ -16,22 +13,22 @@
<br>
</p>

There are multiple ways to deploy Nebula Graph, but using Docker Compose is usually considered to be a fast starter. This repository provides a convenient solution to deploy Nebula Graph with Docker Compose.

Choose a nebula-docker-compose branch before you start. The following table lists the most popular nebula-docker-compose branches and the corresponding Nebula Graph GitHub branches and versions.
NebulaGraph can be deployed using several methods, with Docker Compose being one of the quickest and easiest. This repository contains Docker Compose configuration files for various versions of NebulaGraph, organized across different branches. Refer to the table below for the most commonly used branches, along with their corresponding NebulaGraph versions. Typically, the highest version number in the v3.x series represents the latest stable release.

For minor version of docker images(2.6.2 for instance), please check tags from the docker hub i.e. [here](https://hub.docker.com/r/vesoft/nebula-graphd/tags).
For specific minor versions of Docker images, such as 3.6.1, please consult the tags on Docker Hub, which can be found [here](https://hub.docker.com/r/vesoft/nebula-graphd/tags).

| nebula-docker-compose branch | Nebula Graph branch and repository | Nebula Graph version | How to use nebula-docker-compose |
| :-----------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
| [`master`](https://github.com/vesoft-inc/nebula-docker-compose/tree/master) | `master` of the [nebula](https://github.com/vesoft-inc/nebula) repository | The latest development <br>version of v3.x | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/master/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose/) |
| [`v3.5`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.5.0) | `v3.5.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.5.x | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/3.5.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose/) |
| [`v3.4`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.4.0) | `v3.4.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.4.x | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.3`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.3.0) | `v3.3.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.3.x | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.2`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.2.0) | `v3.2.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.2.x | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.1.0) | `v3.1.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.1.x | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.0.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.0.1) | `v3.0.1` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.0.1 | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v2.6`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.6) <br> | `v2.6` of the [nebula](https://github.com/vesoft-inc/nebula) repository | The latest released version of v.2.6.x | [Deploy Nebula Graph with Docker Compose](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.6/README.md) |
| [`v2.5.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.5.0) | `v2.5.0` of the [nebula-graph](https://github.com/vesoft-inc/nebula-graph) repository | v.2.5.0 | [Deploy Nebula Graph with Docker Compose](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.5.0/README.md) |
| [`v2.0.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.0.0) | `v2.0.0` of the nebula-graph repository | v.2.0.0-GA | [Deploy Nebula Graph with Docker Compose](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.0.0/README.md) |
| [`v1.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v1.0) | `master` of the [nebula](https://github.com/vesoft-inc/nebula) repository | The latest development <br>version of v1.x | [Deploy Nebula Graph with Docker Compose](https://github.com/vesoft-inc/nebula-docker-compose/blob/v1.0/README.md) |
| Branch of This Repo | NebulaGraph | Version Comment | Docs |
| :----------------------------------------------------------: | ------------------------------------------------------------ | ----------------------------- | ------------------------------------------------------------ |
| [`master`](https://github.com/vesoft-inc/nebula-docker-compose/tree/master) | `master` of the [nebula](https://github.com/vesoft-inc/nebula) repository | The latest dev build for v3.x | [Guide](https://docs.nebula-graph.io/master/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose/) |
| [`v3.8`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.8.0) | `v3.8.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.8.x | [Guide](https://docs.nebula-graph.io/3.8.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose/) |
| [`v3.6`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.6.0) | `v3.6.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.6.x | [Guide](https://docs.nebula-graph.io/3.6.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose/) |
| [`v3.5`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.5.0) | `v3.5.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.5.x | [Guide](https://docs.nebula-graph.io/3.5.0/4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose/) |
| [`v3.4`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.4.0) | `v3.4.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.4.x | [Guide](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.3`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.3.0) | `v3.3.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.3.x | [Guide](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.2`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.2.0) | `v3.2.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.2.x | [Guide](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.1.0) | `v3.1.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.1.x | [Guide](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.0.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.0.1) | `v3.0.1` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.0.1 | [Guide](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v2.6`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.6) | `v2.6` of the [nebula](https://github.com/vesoft-inc/nebula) repository | The last v2.x release | [Guide](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.6/README.md) |
| [`v2.5.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.5.0) | `v2.5.0` of the [nebula-graph](https://github.com/vesoft-inc/nebula-graph) repository | v.2.5.0 | [Guide](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.5.0/README.md) |
| [`v2.0.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.0.0) | `v2.0.0` of the nebula-graph repository | v.2.0.0-GA | [Guide](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.0.0/README.md) |
| [`v1.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v1.0) | `master` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v1.0 | [Guide](https://github.com/vesoft-inc/nebula-docker-compose/blob/v1.0/README.md) |
34 changes: 19 additions & 15 deletions README_zh-CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,24 @@
</a>
</p>

部署Nebula Graph的方式有很多，使用Docker Compose是其中较方便的一种。本仓库中保存了使用Docker Compose快速部署Nebula Graph的解决方案。
部署 NebulaGraph 的方式有很多，使用 Docker Compose 是其中较方便的一种。本仓库是 NebulaGraph Docker Compose 的配置文件。

在使用本仓库前，请选择好您需要使用的分支。下表列出了常用分支以及与其相对应的Nebula Graph分支和版本。
更多小版本的 Docker 镜像分支（比如对应 2.6.2 版本的镜像），可以在 Docker Hub 上查询相应 tag，比如[这里](https://hub.docker.com/r/vesoft/nebula-graphd/tags)。
下表列出了常用分支以及与其相对应的 NebulaGraph 分支和版本，通常来说，v3.x 的最大版本就是最新的稳定版本。

| nebula-docker-compose分支 | Nebula Graph分支与仓库 | Nebula Graph版本 | 如何使用本仓库 |
| :-------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------ | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| [`master`](https://github.com/vesoft-inc/nebula-docker-compose/tree/master) | `master` of the [nebula repository](https://github.com/vesoft-inc/nebula) | The latest development <br>version of v3.x | [Docker Compose部署Nebula Graph](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.4`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.4.0) | `v3.4.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.4.x | [Docker Compose部署Nebula Graph](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.3`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.3.0) | `v3.3.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.3.x | [Deploy Nebula Graph with Docker Compose](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.2`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.2.0) | `v3.2.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.2.x | [Docker Compose部署Nebula Graph](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.1.0) | `v3.1.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.1.x | [Docker Compose部署Nebula Graph](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.0.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.0.1) | `v3.0.1` of the [nebula repository](https://github.com/vesoft-inc/nebula) | v3.0.1 | [Docker Compose部署Nebula Graph](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v2.6`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.6) <br> | `v2.6` of the nebula-graph repository | The latest released version of v.2.6.x | [Docker Compose部署Nebula Graph](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.6/README.md) |
| [`v2.5.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.5.0) | `v2.5.0` of the nebula-graph repository | v.2.5.0 | [Docker Compose部署Nebula Graph](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.5.0/README.md) |
| [`v2.0.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.0.0) | `v2.0.0` of the nebula-graph repository | v.2.0.0-GA | [Docker Compose部署Nebula Graph](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.0.0/README.md) |
| [`v1.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v1.0) | `master` of the [nebula](https://github.com/vesoft-inc/nebula) repository | The latest development <br>version of v1.x | [Docker Compose部署Nebula Graph](https://github.com/vesoft-inc/nebula-docker-compose/blob/v1.0/README.md) |
更多小版本的 Docker 镜像分支（比如对应 3.6.1 版本的镜像），可以在 Docker Hub 上查询相应镜像的标签（tag），比如[这里](https://hub.docker.com/r/vesoft/nebula-graphd/tags)。

| 本仓库分支 | NebulaGraph | 版本解释 | 如何部署 |
| :----------------------------------------------------------: | ------------------------------------------------------------ | ------------------- | ------------------------------------------------------------ |
| [`master`](https://github.com/vesoft-inc/nebula-docker-compose/tree/master) | `master` of the [nebula repository](https://github.com/vesoft-inc/nebula) | v3.x 的最新开发版本 | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.8`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.8.0) | `v3.8.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.8.x | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.6`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.6.0) | `v3.6.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.6.x | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.5`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.5.0) | `v3.5.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.5.x | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.4`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.4.0) | `v3.4.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.4.x | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.3`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.3.0) | `v3.3.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.3.x | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.2`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.2.0) | `v3.2.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.2.x | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.1.0) | `v3.1.x` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v3.1.x | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v3.0.1`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v3.0.1) | `v3.0.1` of the [nebula repository](https://github.com/vesoft-inc/nebula) | v3.0.1 | [文档](https://docs.nebula-graph.io/2.0/2.quick-start/2.deploy-nebula-graph-with-docker-compose/) |
| [`v2.6`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.6) | `v2.6` of the nebula-graph repository | v2.x 的最后发布 | [文档](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.6/README.md) |
| [`v2.5.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.5.0) | `v2.5.0` of the nebula-graph repository | v.2.5.0 | [文档](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.5.0/README.md) |
| [`v2.0.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v2.0.0) | `v2.0.0` of the nebula-graph repository | v.2.0.0-GA | [文档](https://github.com/vesoft-inc/nebula-docker-compose/blob/v2.0.0/README.md) |
| [`v1.0`](https://github.com/vesoft-inc/nebula-docker-compose/tree/v1.0) | `master` of the [nebula](https://github.com/vesoft-inc/nebula) repository | v1 | [文档](https://github.com/vesoft-inc/nebula-docker-compose/blob/v1.0/README.md) |

0 comments on commit 1f41987

Please sign in to comment.