Skip to content

Commit

Permalink
whitespace before link error fix (#1258)
Browse files Browse the repository at this point in the history
  • Loading branch information
abby-cyber authored Nov 24, 2021
1 parent 8da926c commit bb68ce6
Show file tree
Hide file tree
Showing 154 changed files with 369 additions and 369 deletions.
8 changes: 4 additions & 4 deletions docs-2.0/1.introduction/1.what-is-nebula-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Nebula Graph 提供 Java、Python、C++和 Go 等流行编程语言的客户端

### 高可靠访问控制

Nebula Graph 支持严格的角色访问控制和 LDAP(Lightweight Directory Access Protocol)等外部认证服务,能够有效提高数据安全性。详情请参见 [验证和授权](../7.data-security/1.authentication/1.authentication.md)
Nebula Graph 支持严格的角色访问控制和 LDAP(Lightweight Directory Access Protocol)等外部认证服务,能够有效提高数据安全性。详情请参见[验证和授权](../7.data-security/1.authentication/1.authentication.md)

### 生态多样化

Nebula Graph 开放了越来越多的原生工具,例如 [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-studio)[Nebula Console](https://github.com/vesoft-inc/nebula-console)[Nebula Exchange](https://github.com/vesoft-inc/nebula-exchange) 等,更多工具可以查看 [生态工具概览](../20.appendix/6.eco-tool-version.md)
Nebula Graph 开放了越来越多的原生工具,例如 [Nebula Graph Studio](https://github.com/vesoft-inc/nebula-studio)[Nebula Console](https://github.com/vesoft-inc/nebula-console)[Nebula Exchange](https://github.com/vesoft-inc/nebula-exchange) 等,更多工具可以查看[生态工具概览](../20.appendix/6.eco-tool-version.md)

此外,Nebula Graph 还具备与 Spark、Flink、HBase 等产品整合的能力,在这个充满挑战与机遇的时代,大大增强了自身的竞争力。

Expand All @@ -48,12 +48,12 @@ Nebula Graph 查询语言,简称为 nGQL,是一种声明性的、部分兼

### 面向未来硬件,读写平衡

闪存型设备有着极高的性能,并且 [价格快速下降](https://blocksandfiles.com/wp-content/uploads/2021/01/Wikibon-SSD-less-than-HDD-in-2026.jpg)
闪存型设备有着极高的性能,并且[价格快速下降](https://blocksandfiles.com/wp-content/uploads/2021/01/Wikibon-SSD-less-than-HDD-in-2026.jpg)
Nebula Graph 是一个面向 SSD 设计的产品,相比于基于 HDD + 大内存的产品,更适合面向未来的硬件趋势,也更容易做到读写平衡。

### 灵活数据建模

用户可以轻松地在 Nebula Graph 中建立数据模型,不必将数据强制转换为关系表。而且可以自由增加、更新和删除属性。详情请参见 [数据模型](2.data-model.md)
用户可以轻松地在 Nebula Graph 中建立数据模型,不必将数据强制转换为关系表。而且可以自由增加、更新和删除属性。详情请参见[数据模型](2.data-model.md)

### 广受欢迎

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/1.introduction/2.1.path.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

图论中一个非常重要的概念是路径,路径是指一个有限或无限的边序列,这些边连接着一系列点。

路径的类型分为三种:`walk``trail``path`。关于路径的详细说明,请参见 [维基百科](https://en.wikipedia.org/wiki/Path_(graph_theory)#Walk,_trail,_path)
路径的类型分为三种:`walk``trail``path`。关于路径的详细说明,请参见[维基百科](https://en.wikipedia.org/wiki/Path_(graph_theory)#Walk,_trail,_path)

本文以下图为例进行简单介绍。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ leader 是由多数派选举出来,只有 leader 能够对客户端或其他

Meta 服务中存储了用户的账号和权限信息,当客户端通过账号发送请求给 Meta 服务,Meta 服务会检查账号信息,以及该账号是否有对应的请求权限。

更多 Nebula Graph 的访问控制说明,请参见 [身份验证](../../7.data-security/1.authentication/1.authentication.md)
更多 Nebula Graph 的访问控制说明,请参见[身份验证](../../7.data-security/1.authentication/1.authentication.md)

### 管理分片

Expand All @@ -41,7 +41,7 @@ Nebula Graph 是强类型图数据库,它的 Schema 包括 Tag、Edge type、T

Meta 服务中存储了 Schema 信息,同时还负责 Schema 的添加、修改和删除,并记录它们的版本。

更多 Nebula Graph 的 Schema 信息,请参见 [数据模型](../2.data-model.md)
更多 Nebula Graph 的 Schema 信息,请参见[数据模型](../2.data-model.md)

### 管理 TTL 信息

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Nebula Graph 的存储包含两个部分,一个是 Meta 相关的存储,称

- 高可用性(Raft)

- 支持向第三方系统进行同步(例如 [全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)
- 支持向第三方系统进行同步(例如[全文索引](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md)

## Storage 服务架构

Expand All @@ -26,7 +26,7 @@ Storage 服务是由 nebula-storaged 进程提供的,用户可以根据场景

- Storage interface 层

Storage 服务的最上层,定义了一系列和图相关的 API。API 请求会在这一层被翻译成一组针对 [分片](#数据分片)的 KV 操作,例如:
Storage 服务的最上层,定义了一系列和图相关的 API。API 请求会在这一层被翻译成一组针对[分片](#数据分片)的 KV 操作,例如:

- `getNeighbors`:查询一批点的出边或者入边,返回边以及对应的属性,并且支持条件过滤。

Expand Down Expand Up @@ -154,7 +154,7 @@ EdgeA_Out 和 EdgeA_In 以方向相反的两条边的形式存在于存储层,

点和边分布在不同的分片,分片分布在不同的机器。分片数量在 CREATE SPACE 语句中指定,此后不可更改。

如果需要将某些点放置在相同的分片(例如在一台机器上),可以参考 [公式或代码](https://github.com/vesoft-inc/nebula-common/blob/master/src/common/clients/meta/MetaClient.cpp)
如果需要将某些点放置在相同的分片(例如在一台机器上),可以参考[公式或代码](https://github.com/vesoft-inc/nebula-common/blob/master/src/common/clients/meta/MetaClient.cpp)

下文用简单代码说明 VID 和分片的关系。

Expand Down Expand Up @@ -239,12 +239,12 @@ Listener 角色的存在主要是为了应对**扩容**,扩容时新增的机
新增 Listener 角色后,会写入 command 类型的 WAL,leader 在写 WAL 时如果发现有`add learner`的 command,会将 learner 加入自己的 peers,并将它标记为 Listener,在统计多数派的时候,不会算上 Listener,但是日志还是会照常发送给它们,Listener 本身也不会主动发起选举。
Raft listener 进程还可以从 Leader 获取数据后,然后将它们写入 Elasticsearch 集群,以便实现全文搜索。详情请参见 [部署 Raft Listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。
Raft listener 进程还可以从 Leader 获取数据后,然后将它们写入 Elasticsearch 集群,以便实现全文搜索。详情请参见[部署 Raft Listener](../../4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md)。
-->

### leader 切换(Transfer Leadership)

leader 切换对于负载均衡至关重要,当把某个分片从一台机器迁移到另一台机器时,首先会检查分片是不是 leader,如果是的话,需要先切换 leader,数据迁移完毕之后,通常还要重新 [均衡 leader 分布](../../8.service-tuning/load-balance.md)
leader 切换对于负载均衡至关重要,当把某个分片从一台机器迁移到另一台机器时,首先会检查分片是不是 leader,如果是的话,需要先切换 leader,数据迁移完毕之后,通常还要重新[均衡 leader 分布](../../8.service-tuning/load-balance.md)

对于 leader 来说,提交 leader 切换命令时,就会放弃自己的 leader 身份,当 follower 收到 leader 切换命令时,就会发起选举。

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/1.introduction/3.vid.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ VID 的生成工作完全交给应用端,有一些通用的建议:

## 定义和修改 VID 的数据类型

VID 的数据类型必须在 [创建图空间](../3.ngql-guide/9.space-statements/1.create-space.md) 时定义,且一旦定义无法修改。
VID 的数据类型必须在[创建图空间](../3.ngql-guide/9.space-statements/1.create-space.md) 时定义,且一旦定义无法修改。

## "查询起始点"(`start vid`) 与全局扫描

Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/14.client/3.nebula-cpp-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- 已安装 C++,GCC 版本为 4.8 及以上。

- 编译安装需要准备正确的编译环境,详情请参见 [软硬件要求和安装三方库依赖包](../4.deployment-and-installation/1.resource-preparations.md)
- 编译安装需要准备正确的编译环境,详情请参见[软硬件要求和安装三方库依赖包](../4.deployment-and-installation/1.resource-preparations.md)

## 版本对照表

Expand Down Expand Up @@ -82,7 +82,7 @@

将 CPP 文件编译为可执行文件即可。接下来以`SessionExample.cpp`为例,介绍如何操作。

1. 使用 [示例代码](https://github.com/vesoft-inc/nebula-cpp/blob/master/examples/SessionExample.cpp) 创建`SessionExample.cpp`文件。
1. 使用[示例代码](https://github.com/vesoft-inc/nebula-cpp/blob/master/examples/SessionExample.cpp) 创建`SessionExample.cpp`文件。

2. 编译文件,命令如下:

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/14.client/4.nebula-java-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
</repositories>
```

如果没有 Maven 管理项目,请手动 [下载 JAR 包](https://repo1.maven.org/maven2/com/vesoft/) 进行安装。
如果没有 Maven 管理项目,请手动[下载 JAR 包](https://repo1.maven.org/maven2/com/vesoft/) 进行安装。

### 核心代码

Expand Down
6 changes: 3 additions & 3 deletions docs-2.0/15.contribution/how-to-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### github 或社区提交问题

欢迎为项目贡献任何代码或文档,但是建议先在 [github](https://github.com/vesoft-inc/nebula) [社区](https://discuss.nebula-graph.io/) 上提交一个问题,和大家共同讨论。
欢迎为项目贡献任何代码或文档,但是建议先在 [github](https://github.com/vesoft-inc/nebula)[社区](https://discuss.nebula-graph.io/) 上提交一个问题,和大家共同讨论。

### 签署贡献者许可协议(CLA)

Expand All @@ -28,7 +28,7 @@ Nebula Graph 文档以 Markdown 语言编写。单击文档标题右侧的铅笔

### Step 1:通过 GitHub fork 仓库

Nebula Graph 项目有很多 [仓库](https://github.com/vesoft-inc),以 [nebula-graph 仓库](https://github.com/vesoft-inc/nebula) 为例:
Nebula Graph 项目有很多[仓库](https://github.com/vesoft-inc),以 [nebula-graph 仓库](https://github.com/vesoft-inc/nebula) 为例:

1. 访问 [https://github.com/vesoft-inc/nebula](https://github.com/vesoft-inc/nebula)

Expand Down Expand Up @@ -132,7 +132,7 @@ Nebula Graph 项目有很多 [仓库](https://github.com/vesoft-inc),以 [nebu

- 构建代码时开启单元测试

详情请参见 [使用源码安装 Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)
详情请参见[使用源码安装 Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)

!!! Note

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/2.quick-start/1.quick-start-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

1. [安装 Nebula Graph](../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)

使用 RPM 或 DEB 文件可以快速安装 Nebula Graph。其它部署方式及相应的准备工作请参见 [安装部署](../4.deployment-and-installation/1.resource-preparations.md)
使用 RPM 或 DEB 文件可以快速安装 Nebula Graph。其它部署方式及相应的准备工作请参见[安装部署](../4.deployment-and-installation/1.resource-preparations.md)

2. [启动 Nebula Graph](5.start-stop-service.md)

Expand Down
14 changes: 7 additions & 7 deletions docs-2.0/2.quick-start/4.nebula-graph-crud.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
| 边(Edge) | 表示两个点之间**有方向**的关系。|
| 边类型(Edge type) | 边的类型,定义了一组描述边的类型的属性。 |

更多信息,请参见 [数据结构](../1.introduction/2.data-model.md)
更多信息,请参见[数据结构](../1.introduction/2.data-model.md)

本文将使用下图的数据集演示基础操作的语法。

Expand Down Expand Up @@ -61,7 +61,7 @@ nebula> SHOW HOSTS;

!!! Note

默认心跳周期是 10 秒。修改心跳周期参数`heartbeat_interval_secs`,请参见 [配置简介](../5.configurations-and-logs/1.configurations/1.configurations.md)。
默认心跳周期是 10 秒。修改心跳周期参数`heartbeat_interval_secs`,请参见[配置简介](../5.configurations-and-logs/1.configurations/1.configurations.md)。

为确保数据同步,后续操作能顺利进行,可采取以下方法之一:

Expand Down Expand Up @@ -236,9 +236,9 @@ nebula> CREATE EDGE serve(start_year int, end_year int);
- [FETCH](../3.ngql-guide/7.general-query-statements/4.fetch.md) 语句可以获得点或边的属性。
- [LOOKUP](../3.ngql-guide/7.general-query-statements/5.lookup.md) 语句是基于 [索引](#_12) 的,和`WHERE`子句一起使用,查找符合特定条件的数据。
- [LOOKUP](../3.ngql-guide/7.general-query-statements/5.lookup.md) 语句是基于[索引](#_12) 的,和`WHERE`子句一起使用,查找符合特定条件的数据。
- [MATCH](../3ngql-guide/../3.ngql-guide/7.general-query-statements/2.match.md) 语句是查询图数据最常用的,可以灵活的描述各种图模式,但是它依赖 [索引](#_12) 去匹配 Nebula Graph 中的数据模型,性能也还需要调优。
- [MATCH](../3ngql-guide/../3.ngql-guide/7.general-query-statements/2.match.md) 语句是查询图数据最常用的,可以灵活的描述各种图模式,但是它依赖[索引](#_12) 去匹配 Nebula Graph 中的数据模型,性能也还需要调优。
### nGQL 语法
Expand Down Expand Up @@ -371,7 +371,7 @@ nebula> FETCH PROP ON player "player100";

!!! Note

`LOOKUP`和`MATCH`的示例在下文的 [索引](#_12) 部分查看。
`LOOKUP`和`MATCH`的示例在下文的[索引](#_12) 部分查看。

## 修改点和边

Expand Down Expand Up @@ -488,7 +488,7 @@ nebula> FETCH PROP ON player "player100";
`MATCH`和`LOOKUP`语句的执行都依赖索引,但是索引会导致写性能大幅降低(降低 90%甚至更多)。请**不要随意**在生产环境中使用索引,除非很清楚使用索引对业务的影响。
**必须**为“已写入但未构建索引”的数据重建索引,否则无法在`MATCH`和`LOOKUP`语句中返回这些数据。参见 [重建索引](../3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md)。
**必须**为“已写入但未构建索引”的数据重建索引,否则无法在`MATCH`和`LOOKUP`语句中返回这些数据。参见[重建索引](../3.ngql-guide/14.native-index-statements/4.rebuild-native-index.md)。
### nGQL 语法
Expand All @@ -507,7 +507,7 @@ nebula> FETCH PROP ON player "player100";
!!! Note
为没有指定长度的变量属性创建索引时,需要指定索引长度。在 utf-8 编码中,一个中文字符占 3 字节,请根据变量属性长度设置合适的索引长度。例如 10 个中文字符,索引长度需要为 30。详情请参见 [创建索引](../3.ngql-guide/14.native-index-statements/1.create-native-index.md#_6)。
为没有指定长度的变量属性创建索引时,需要指定索引长度。在 utf-8 编码中,一个中文字符占 3 字节,请根据变量属性长度设置合适的索引长度。例如 10 个中文字符,索引长度需要为 30。详情请参见[创建索引](../3.ngql-guide/14.native-index-statements/1.create-native-index.md#_6)。
### 基于索引的`LOOKUP`和`MATCH`示例
Expand Down
Loading

0 comments on commit bb68ce6

Please sign in to comment.