Skip to content

Commit

Permalink
quick-start-opt-link-change (#2186)
Browse files Browse the repository at this point in the history
* quick-start-opt-link-change

* Update mkdocs.yml
  • Loading branch information
abby-cyber authored Sep 30, 2022
1 parent ac85520 commit d5f92f3
Show file tree
Hide file tree
Showing 28 changed files with 47 additions and 38 deletions.
4 changes: 2 additions & 2 deletions docs-2.0/20.appendix/0.FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ nGQL 没有该功能。

例如执行 `MATCH (n) RETURN (n)`. 会返回错误 `Scan vertices or edges need to specify a limit number, or limit number can not push down.`

一个办法是使用 [NebulaGraph Algorithm](../graph-computing/nebula-algorithm.md).
一个办法是使用 [NebulaGraph Algorithm](../graph-computing/nebula-algorithm.md)

或者指定各 Tag/Edge Type,然后再自己通过 `Union` 拼装。

Expand Down Expand Up @@ -370,7 +370,7 @@ NebulaGraph {{ nebula.release }} 未提供运维命令以实现自动扩缩容

- storaged 的缩容:详情参见[缩容命令](../8.service-tuning/load-balance.md#_5)。完成后关闭 storaged 进程。

- storaged 的扩容:在新机器上准备 storaged 二进制文件和配置文件,在配置文件中修改或增加已在运行的 metad 地址,然后注册 storaged 到 metad 并启动 storaged 进程。详情参见[注册 Storage 服务](../2.quick-start/3.1add-storage-hosts.md)
- storaged 的扩容:在新机器上准备 storaged 二进制文件和配置文件,在配置文件中修改或增加已在运行的 metad 地址,然后注册 storaged 到 metad 并启动 storaged 进程。详情参见[注册 Storage 服务](../2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md)

storaged 扩缩容之后,还需要运行 [Balance Data 和 Balance Leader 命令](../8.service-tuning/load-balance.md)

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/20.appendix/write-tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

有多种方式可以写入 NebulaGraph {{ nebula.release }}:

- 使用[命令行 -f 的方式](../2.quick-start/3.connect-to-nebula-graph.md)导入:可以导入少量准备好的 nGQL 文件,适合少量手工测试数据准备;
- 使用[命令行 -f 的方式](../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)导入:可以导入少量准备好的 nGQL 文件,适合少量手工测试数据准备;
- 使用 [studio 导入](../nebula-studio/quick-start/st-ug-import-data.md):可以用过浏览器导入本机多个 csv 文件,格式有限制;
- 使用 [importer 导入](../nebula-importer/use-importer.md):导入单机多个 csv 文件,大小没有限制,格式灵活;数据量十亿级以内;
- 使用 [Exchange 导入](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md):从 Neo4j, Hive, MySQL 等多种源分布式导入,需要有 Spark 集群;数据量十亿级以上
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/3.ngql-guide/1.nGQL-overview/1.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ nGQL 是一个进行中的项目,会持续发布新特性和优化,因此可

## 示例数据 Basketballplayer

用户可以下载 NebulaGraph 示例数据 [basketballplayer 文件](https://docs.nebula-graph.io/2.0/basketballplayer-2.X.ngql),然后使用 [NebulaGraph Console](../../2.quick-start/3.connect-to-nebula-graph.md),使用选项`-f`执行脚本。
用户可以下载 NebulaGraph 示例数据 [basketballplayer 文件](https://docs.nebula-graph.io/2.0/basketballplayer-2.X.ngql),然后使用 [NebulaGraph Console](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md),使用选项`-f`执行脚本。

!!! note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ master 分支的代码更新速度快,如果安装了 master 分支对应的
- (企业版)[设置 License](../deploy-license.md)
{{ ent.ent_end }}

- [管理 NebulaGraph 服务](../../2.quick-start/5.start-stop-service.md)
- [管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)

## CMake 参数

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,11 +285,11 @@ sudo /usr/local/nebula/scripts/nebula.service start <metad|graphd|storaged|all>

- 当需都启动 graphd、storaged 和 metad 时,可以用 all 代替。

- `/usr/local/nebula`是 NebulaGraph 的默认安装路径,如果修改过安装路径,请使用实际路径。更多启停服务的内容,请参见[管理 NebulaGraph 服务](../../2.quick-start/5.start-stop-service.md)。
- `/usr/local/nebula`是 NebulaGraph 的默认安装路径,如果修改过安装路径,请使用实际路径。更多启停服务的内容,请参见[管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。

### 检查集群

安装原生 CLI 客户端 [NebulaGraph Console](../../2.quick-start/3.connect-to-nebula-graph.md#_1),然后连接任何一个已启动 graphd 进程的机器,添加 Storage 主机,然后执行命令`SHOW HOSTS`检查集群状态。例如:
安装原生 CLI 客户端 [NebulaGraph Console](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md#_1),然后连接任何一个已启动 graphd 进程的机器,添加 Storage 主机,然后执行命令`SHOW HOSTS`检查集群状态。例如:

```bash
$ ./nebula-console --addr 192.168.10.111 --port 9669 -u root -p nebula
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ NebulaGraph v3.0.x 升级至 v{{nebula.release}},只需要使用 v{{nebula.rel

1. 下载 [RPM/DEB 包](https://github.com/vesoft-inc/nebula-graph/releases/tag/v{{nebula.release}})

2. 停止所有 NebulaGraph 服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/5.start-stop-service.md)。建议更新前备份配置文件。
2. 停止所有 NebulaGraph 服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)。建议更新前备份配置文件。

3. 执行如下命令升级:

Expand All @@ -28,7 +28,7 @@ NebulaGraph v3.0.x 升级至 v{{nebula.release}},只需要使用 v{{nebula.rel
$ sudo dpkg -i <package_name>
```

4. 在每台服务器上启动所需的服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/5.start-stop-service.md#_1)。
4. 在每台服务器上启动所需的服务。详情请参见[管理 NebulaGraph 服务](../../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md#_1)。

## 编译新版本源码升级步骤

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## 前提条件

停止 NebulaGraph 服务。详情参见[管理 NebulaGraph 服务](../2.quick-start/5.start-stop-service.md)
停止 NebulaGraph 服务。详情参见[管理 NebulaGraph 服务](../2.quick-start/3.quick-start-on-premise/5.start-stop-service.md)

## 步骤 1:删除数据和元数据文件

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ listener 进程与 storaged 进程使用相同的二进制文件,但是二者

### 第四步:添加 listener 到 NebulaGraph 集群

[用命令行连接到 NebulaGraph](../../2.quick-start/3.connect-to-nebula-graph.md),然后执行 [`USE <space>`](../../3.ngql-guide/9.space-statements/2.use-space.md) 进入需要创建全文索引的图空间。然后执行如下命令添加 listener:
[用命令行连接到 NebulaGraph](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md),然后执行 [`USE <space>`](../../3.ngql-guide/9.space-statements/2.use-space.md) 进入需要创建全文索引的图空间。然后执行如下命令添加 listener:

```ngql
ADD LISTENER ELASTICSEARCH <listener_ip:port> [,<listener_ip:port>, ...]
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ NebulaGraph 是一款开源的、分布式的、易扩展的原生图数据库
## 快速开始
* [学习路径](20.appendix/learning-path.md)[获取认证](https://academic.nebula-graph.io/?lang=ZH_CN)
* [什么是 NebulaGraph](1.introduction/1.what-is-nebula-graph.md)
* [快速开始](2.quick-start/1.quick-start-workflow.md)
* [快速开始](2.quick-start/1.quick-start-overview.md)
* [部署要求](4.deployment-and-installation/1.resource-preparations.md)
* [nGQL 命令汇总](2.quick-start/6.cheatsheet-for-ngql-command.md)
* [FAQ](20.appendix/0.FAQ.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,4 @@ Solution 可在 Connectivity 中设置 Private Link 让用户能够通过虚拟

## 如何使用私有链接连接 NebulaGraph

用户可以使用私有链接通过 NebulaGraph Console 连接 NebulaGraph。详情信息,参见[连接 NebulaGraph](../../2.quick-start/3.connect-to-nebula-graph.md)
用户可以使用私有链接通过 NebulaGraph Console 连接 NebulaGraph。详情信息,参见[连接 NebulaGraph](../../2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md)
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:修改配置文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:处理 CSV 文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ ROW COLUMN+CELL
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:修改配置文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ scala> spark.sql("describe basketball.serve").show
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:使用 Spark SQL 确认 Hive SQL 语句
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:处理 JSON 文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:修改配置文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:修改配置文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ mysql> desc serve;
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:修改配置文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Exchange 读取 Neo4j 数据时需要完成以下工作:
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:配置源数据
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ oracle> desc serve;
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:修改配置文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:处理 ORC 文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:处理 Parquet 文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:修改配置文件
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ SST 文件是一个内部包含了任意长度的有序键值对集合的文件
nebula> CREATE EDGE serve(start_year int, end_year int);
```
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-workflow.md)。
更多信息,请参见[快速开始](../../2.quick-start/1.quick-start-overview.md)。
### 步骤 2:处理 CSV 文件
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/nebula-studio/quick-start/st-ug-create-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

!!! Note

用户也可以使用 nebula-console 创建 Schema。详细信息,参考 [NebulaGraph 使用手册](../../README.md)和 [NebulaGraph 快速开始](../../2.quick-start/1.quick-start-workflow.md)。
用户也可以使用 nebula-console 创建 Schema。详细信息,参考 [NebulaGraph 使用手册](../../README.md)和 [NebulaGraph 快速开始](../../2.quick-start/1.quick-start-overview.md)。

## 前提条件

Expand Down
8 changes: 6 additions & 2 deletions docs-2.0/reuse/source_connect-to-nebula-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

!!! caution

首次连接到 NebulaGraph 后,必须先[注册 Storage 服务](../2.quick-start/3.1add-storage-hosts.md),才能正常查询数据。
首次连接到 NebulaGraph 后,必须先[注册 Storage 服务](https://docs.nebula-graph.com.cn/{{nebula.release}}/2.quick-start/3.1add-storage-hosts/),才能正常查询数据。

NebulaGraph 支持多种类型的客户端,包括命令行客户端、可视化界面客户端和流行编程语言客户端。详情参见[客户端列表](../14.client/1.nebula-client.md)
NebulaGraph 支持多种类型的客户端,包括命令行客户端、可视化界面客户端和流行编程语言客户端。详情参见[客户端列表](https://docs.nebula-graph.com.cn/{{nebula.release}}/14.client/1.nebula-client/)

## 前提条件

Expand Down Expand Up @@ -81,3 +81,7 @@ NebulaGraph 支持多种类型的客户端,包括命令行客户端、可视
| `-ssl_private_key_path` | 指定私钥文件的存储路径。 |

更多参数参见[项目仓库](https://github.com/vesoft-inc/nebula-console/tree/{{console.branch}})。




2 changes: 1 addition & 1 deletion docs-2.0/reuse/source_manage-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ $ sudo /usr/local/nebula/scripts/nebula.service status all
!!! note
正常启动 NebulaGraph 后,`nebula-storaged`进程的端口显示红色。这是因为`nebula-storaged`在启动流程中会等待`nebula-metad`添加当前 Storage 服务,当前 Storage 服务收到 Ready 信号后才会正式启动服务。从 3.0.0 版本开始,在配置文件中添加的 Storage 节点无法直接读写,配置文件的作用仅仅是将 Storage 节点注册至 Meta 服务中。必须使用`ADD HOSTS`命令后,才能正常读写 Storage 节点。更多信息,参见[管理 Storage 主机](../4.deployment-and-installation/manage-storage-host.md)。
正常启动 NebulaGraph 后,`nebula-storaged`进程的端口显示红色。这是因为`nebula-storaged`在启动流程中会等待`nebula-metad`添加当前 Storage 服务,当前 Storage 服务收到 Ready 信号后才会正式启动服务。从 3.0.0 版本开始,在配置文件中添加的 Storage 节点无法直接读写,配置文件的作用仅仅是将 Storage 节点注册至 Meta 服务中。必须使用`ADD HOSTS`命令后,才能正常读写 Storage 节点。更多信息,参见[管理 Storage 主机](https://docs.nebula-graph.com.cn/{{nebula.release}}/4.deployment-and-installation/manage-storage-host/)。
- 如果返回类似如下结果,表示 NebulaGraph 服务异常,可以根据异常服务信息进一步排查,或者在 [NebulaGraph 社区](https://discuss.nebula-graph.com.cn/)寻求帮助。
Expand Down
19 changes: 12 additions & 7 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -272,13 +272,18 @@ nav:
- Storage 服务: 1.introduction/3.nebula-graph-architecture/4.storage-service.md

- 快速入门:
- 快速入门流程: 2.quick-start/1.quick-start-workflow.md
- 步骤1:安装 NebulaGraph: 2.quick-start/2.install-nebula-graph.md
- 步骤2:启动 NebulaGraph: 2.quick-start/5.start-stop-service.md
- 步骤3:连接 NebulaGraph: 2.quick-start/3.connect-to-nebula-graph.md
- 步骤4:注册 Storage 服务: 2.quick-start/3.1add-storage-hosts.md
- 步骤5:使用常用命令: 2.quick-start/4.nebula-graph-crud.md
- nGQL 命令汇总: 2.quick-start/6.cheatsheet-for-ngql-command.md
- 入门概览: 2.quick-start/1.quick-start-overview.md
- 从云开始(免费试用):
- 步骤 1:创建云服务实例: 2.quick-start/2.quick-start-on-cloud/1.create-instance-on-cloud.md
- 步骤 2:连接 NebulaGraph: 2.quick-start/2.quick-start-on-cloud/2.connect-to-nebulagraph-on-cloud.md
- 步骤 3:管理数据: 2.quick-start/2.quick-start-on-cloud/3.how-to-query-on-cloud.md
- 本地部署:
- 步骤 1:安装 NebulaGraph: 2.quick-start/3.quick-start-on-premise/2.install-nebula-graph.md
- 步骤 2:启动 NebulaGraph: 2.quick-start/3.quick-start-on-premise/5.start-stop-service.md
- 步骤 3:连接 NebulaGraph: 2.quick-start/3.quick-start-on-premise/3.connect-to-nebula-graph.md
- 步骤 4:注册 Storage 服务: 2.quick-start/3.quick-start-on-premise/3.1add-storage-hosts.md
- 步骤 5:使用基本 nGQL 命令: 2.quick-start/3.quick-start-on-premise/4.nebula-graph-crud.md
- nGQL 命令汇总: 2.quick-start/6.cheatsheet-for-ngql-command.md

- nGQL 指南:
- nGQL 概述:
Expand Down

0 comments on commit d5f92f3

Please sign in to comment.