repair links (#681)

vesoft-inc · Sep 2, 2021 · 6580b11 · 6580b11
1 parent 4e2492c
commit 6580b11
Show file tree

Hide file tree

Showing 15 changed files with 37 additions and 84 deletions.
diff --git a/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md b/docs-2.0/1.introduction/3.nebula-graph-architecture/4.storage-service.md
@@ -14,7 +14,7 @@ The other is the Storage Service that stores the data, which is run by the nebul
 
 - High availability (Raft)
 
-- Supports synchronizing with the third party systems, such as [Elasticsearch](../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md).
+- Supports synchronizing with the third party systems, such as [Elasticsearch](../../4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md).
 
 ## The architecture of Storage Service
 

diff --git a/docs-2.0/20.appendix/write-tools.md b/docs-2.0/20.appendix/write-tools.md
@@ -6,7 +6,7 @@ There are many ways to write Nebula Graph {{ nebula.release }}:
 - Import with [Studio](../nebula-studio/quick-start/st-ug-import-data.md): This method uses a browser to import multiple csv files of this machine. A single file cannot exceed 100 MB, and its format is limited.
 - Import with [Importer](../nebula-importer/use-importer.md): This method imports multiple csv files on a single machine with unlimited size and flexible format.
 - Import with [Exchange](../nebula-exchange/about-exchange/ex-ug-what-is-exchange.md): This method imports from various distribution sources, such as Neo4j, Hive, MySQL, etc., which requires a Spark cluster.
-- Import with [Spark-connector](../spark-connector/sc-ug-what-is-spark-connector.md)/[Flink-connector](../nebula-flink/nf-ug-what-is-flink-connector.md): This method has corresponding components (Spark/Flink) and writes a small amount of code.
+- Import with [Spark-connector](../nebula-spark-connector.md)/[Flink-connector](../nebula-flink-connector.md): This method has corresponding components (Spark/Flink) and writes a small amount of code.
 - Import with [C++/GO/Java/Python SDK](../20.appendix/6.eco-tool-version.md): This method imports in the way of writing programs, which requires certain programming and tuning skills.
 
 The following figure shows the positions of these ways:

diff --git a/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md b/docs-2.0/3.ngql-guide/11.edge-type-statements/3.alter-edge.md
@@ -44,7 +44,7 @@ Trying to use a newly altered edge type may fail because the alteration of the e
 
 Nebula Graph implements the alteration of the edge type in the next heartbeat cycle. To make sure the alteration is successful, take one of the following approaches:
 
-- Use [`DESCRIBE EDGE`](5.describe-tag.md) to confirm that the edge type information is updated. If it is not, wait a few seconds and try again.
+- Use [`DESCRIBE EDGE`](5.describe-edge.md) to confirm that the edge type information is updated. If it is not, wait a few seconds and try again.
 
 - Wait for two heartbeat cycles, i.e., 20 seconds.
 

diff --git a/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md b/docs-2.0/3.ngql-guide/16.subgraph-and-path/1.get-subgraph.md
@@ -90,7 +90,7 @@ To show the completeness of the subgraph, an additional hop is made on all verti
 
 - The returned path of `GET SUBGRAPH 1 STEPS FROM "A" IN follow;` is `B->A`. To show the completeness of the subgraph, an additional hop is made on all vertices that meet the conditions, namely `A->B`.
 
-If you only query paths or vertices that meet the conditions, we suggest you use [MATCH](../7.general-query-statements/2.match.md) or [GO](../7.general-query-statements/3 .go.md). The example is as follows.
+If you only query paths or vertices that meet the conditions, we suggest you use [MATCH](../7.general-query-statements/2.match.md) or [GO](../7.general-query-statements/3.go.md). The example is as follows.
 
 ```ngql
 nebula> match p= (v:player) -- (v2) where id(v)=="A" return p;

diff --git a/docs-2.0/3.ngql-guide/3.data-types/1.numeric.md b/docs-2.0/3.ngql-guide/3.data-types/1.numeric.md
@@ -41,7 +41,7 @@ When writing and reading different types of data, nGQL complies with the followi
 | FLOAT | Not supported | Supported | DOUBLE |
 | DOUBLE | Not supported | Supported | DOUBLE |
 
-For example, nGQL does not support setting [VID](../../1.introduction/3.vid.md) as INT8, but supports setting a certain property type of [TAG](../10.tag-statements/1.create- tag.md) or [Edge type](../11.edge-type-statements/1.create-edge.md) as INT8. When using the nGQL statement to read the property of INT8, the resulted type is INT64.
+For example, nGQL does not support setting [VID](../../1.introduction/3.vid.md) as INT8, but supports setting a certain property type of [TAG](../10.tag-statements/1.create-tag.md) or [Edge type](../11.edge-type-statements/1.create-edge.md) as INT8. When using the nGQL statement to read the property of INT8, the resulted type is INT64.
 
 Multiple formats are supported:
 

diff --git a/...2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md b/...2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md
@@ -57,7 +57,7 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa
 
   !!! Note
 
-        For more information of the preceding services, see [Nebula Graph architecture](../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md).
+        For more information of the preceding services, see [Nebula Graph architecture](../../1.introduction/3.nebula-graph-architecture/1.architecture-overview.md).
 
 4. Connect to Nebula Graph.
 
@@ -88,7 +88,7 @@ Using Docker Compose can quickly deploy Nebula Graph services based on the prepa
 
     !!! Note
 
-        By default, the authentication is off, you can only log in with an existing username (the default is `root`) and any password. To turn it on, see [Enable authentication](../7.data-security/1.authentication/1.authentication.md).
+        By default, the authentication is off, you can only log in with an existing username (the default is `root`) and any password. To turn it on, see [Enable authentication](../../7.data-security/1.authentication/1.authentication.md).
 
    3. Run the `SHOW HOSTS` statement to check the status of the `nebula-storaged` processes.
 
@@ -271,6 +271,6 @@ The data format has been modified on Jan 27, 2021, and is incompatible with the
 
 ## Related documents
 
-- [Install and deploy Nebula Graph with the source code](../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)
-- [Install Nebula Graph by RPM or DEB](../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)
-- [Connect to Nebula Graph](3.connect-to-nebula-graph.md)
+- [Install and deploy Nebula Graph with the source code](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/1.install-nebula-graph-by-compiling-the-source-code.md)
+- [Install Nebula Graph by RPM or DEB](../../4.deployment-and-installation/2.compile-and-install-nebula-graph/2.install-nebula-graph-by-rpm-or-deb.md)
+- [Connect to Nebula Graph](../3.connect-to-nebula-graph.md)
diff --git a/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md b/docs-2.0/6.monitor-and-metrics/1.query-performance-metrics.md
@@ -29,7 +29,7 @@ curl -G "http://<ip>:<port>/stats?stats=<metric_name_list> [&format=json]"
 
 !!! note
 
-    If Nebula Graph is deployed with [Docker Compose](../2.quick-start/2.deploy-nebula-graph-with-docker-compose.md), run `docker-compose ps` to check the ports that are mapped from the service ports inside of the container and then query through them.
+    If Nebula Graph is deployed with [Docker Compose](..//4.deployment-and-installation/2.compile-and-install-nebula-graph/3.deploy-nebula-graph-with-docker-compose.md), run `docker-compose ps` to check the ports that are mapped from the service ports inside of the container and then query through them.
 
 ### Examples
 

diff --git a/docs-2.0/README.md b/docs-2.0/README.md
@@ -15,7 +15,7 @@ Nebula Graph is a distributed, scalable, and lightning-fast graph database. It i
 * [What is Nebula Graph](1.introduction/1.what-is-nebula-graph.md)
 * [Quick start workflow](2.quick-start/1.quick-start-workflow.md)
 * [Configuration](4.deployment-and-installation/1.resource-preparations.md)
-* [FAQ](19.FAQ/0.FAQ.md)
+* [FAQ](20.appendix/0.FAQ.md)
 * [Ecosystem Tools](20.appendix/6.eco-tool-version.md)
 
 ## Other Sources

diff --git a/docs-2.0/images/write-choice.png b/docs-2.0/images/write-choice.png
diff --git a/docs-2.0/nebula-exchange/nebula-exchange.md b/docs-2.0/nebula-exchange/nebula-exchange.md
diff --git a/docs-2.0/nebula-spark-connector.md b/docs-2.0/nebula-spark-connector.md
@@ -217,7 +217,7 @@ df.write.nebula(config, nebulaWriteVertexConfig).writeVertices()
   |`withVidField`  |Yes|  The column in the DataFrame as the vertex ID.  |
   |`withVidPolicy`  |No|  When writing the vertex ID, Nebula Graph 2.x use mapping function, supports HASH only. No mapping is performed by default.  |
   |`withVidAsProp`  |No|  Whether the column in the DataFrame that is the vertex ID is also written as an property. The default value is `false`. If set to `true`, make sure the Tag has the same property name as `VidField`.  |
-  |`withUser`  |No|  Nebula Graph user name. If [authentication]((7.data-security/1.authentication/1.authentication.md)) is disabled, you do not need to configure the user name and password.   |
+  |`withUser`  |No|  Nebula Graph user name. If [authentication](7.data-security/1.authentication/1.authentication.md) is disabled, you do not need to configure the user name and password.   |
   |`withPasswd`  |No|  The password for the Nebula Graph user name.  |
   |`withBatch`  |Yes|  The number of rows of data written at a time. The default value is  `1000`.  |
   |`withWriteMode`|No|Write mode. The optional values are `insert` and `update`. The default value is `insert`.|
@@ -236,7 +236,7 @@ df.write.nebula(config, nebulaWriteVertexConfig).writeVertices()
   |`withSrcAsProperty`  |No| Whether the column in the DataFrame that is the starting vertex is also written as an property.  The default value is `false`. If set to `true`, make sure Edge type has the same property name as `SrcIdField`.   |
   |`withDstAsProperty`  |No| Whether column that are destination vertex in the DataFrame are also written as property. The default value is `false`. If set to `true`, make sure Edge type has the same property name as `DstIdField`.   |
   |`withRankAsProperty`  |No| Whether column in the DataFrame that is the rank is also written as property.The default value is `false`. If set to `true`, make sure Edge type has the same property name as `RankField`.   |
-  |`withUser`  |No|  Nebula Graph user name. If [authentication]((7.data-security/1.authentication/1.authentication.md)) is disabled, you do not need to configure the user name and password.  |
+  |`withUser`  |No|  Nebula Graph user name. If [authentication](7.data-security/1.authentication/1.authentication.md) is disabled, you do not need to configure the user name and password.  |
   |`withPasswd`  |No|  The password for the Nebula Graph user name.  |
   |`withBatch`  |Yes|  The number of rows of data written at a time. The default value is  `1000`.  |
   |`withWriteMode`|No|Write mode. The optional values are `insert` and `update`. The default value is `insert`.|

diff --git a/docs-2.0/nebula-studio/st-ug-toc.md b/docs-2.0/nebula-studio/st-ug-toc.md
@@ -1,28 +1,29 @@
+<!--
 # Nebula Graph Studio User Guide
 
 - About Nebula Graph Studio
   - [What is Nebula Graph Studio](about-studio/st-ug-what-is-graph-studio.md)
-  <!--- [Glossary] [DOC_TO_DO]-->
+  [Glossary] [DOC_TO_DO]
   - [Limitations](about-studio/st-ug-limitations.md)
   - [Check updates](about-studio/st-ug-check-updates.md)
-  <!--- [FAQ] [DOC_TO_DO]-->
+  [FAQ] [DOC_TO_DO]
 
 - Deploy and connect
   - [Deploy Studio](install-configure/st-ug-deploy.md)
   - [Connect to Nebula Graph](install-configure/st-ug-connect.md)
-  <!--- [Clear connection] [DOC_TO_DO]-->
+  [Clear connection] [DOC_TO_DO]
 
   - [Design a schema](quick-start/st-ug-plan-schema.md)
   - [Create a schema](quick-start/st-ug-create-schema.md)
   - [Import data](quick-start/st-ug-import-data.md)
-  - [Query graph data](quick-start/st-ug-explore.md)-->
+  - [Query graph data](quick-start/st-ug-explore.md)
 
 - Operation guide
-  <!-- - Use Schema
+  Use Schema
     - [Operate graph spaces](manage-schema/st-ug-crud-space.md)
     - [Operate tags](manage-schema/st-ug-crud-tag.md)
     - [Operate edge types](manage-schema/st-ug-crud-edge-type.md)
-    - [Operate indexes](manage-schema/st-ug-crud-index.md)-->
+    - [Operate indexes](manage-schema/st-ug-crud-index.md)
   - [Use Explore][DOC_TO_DO]
   - Use Console
     - [Open in Explore](use-console/st-ug-open-in-explore.md)
@@ -32,3 +33,4 @@
   - Troubleshooting [DOC_TO_DO]
     - Connection
     - Error messages
+-->
diff --git a/docs-2.0/reuse/source_connect-to-nebula-graph.md b/docs-2.0/reuse/source_connect-to-nebula-graph.md
@@ -12,7 +12,7 @@ If you don't have a Nebula Graph database yet, we recommend that you try the clo
 
 ### Prerequisites
 
-* You have started the Nebula Graph services. For how to start the services, see [Start and Stop Nebula Graph](./5.start-stop-service.md).
+* You have started the Nebula Graph services. For how to start the services, see [Start and Stop Nebula Graph](../4.deployment-and-installation/manage-service.md).
 * The machine you plan to run Nebula Console on has network access to the Nebula Graph services.
 
 ### Steps

diff --git a/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md b/docs-2.0/reuse/source_install-nebula-graph-by-rpm-or-deb.md
@@ -2,7 +2,7 @@ RPM and DEB are common package formats on Linux systems. This topic shows how to
 
 ## Prerequisites
 
-Prepare the right [resources](../1.resource-preparations.md).
+Prepare the right [resources](../4.deployment-and-installation/1.resource-preparations.md).
 
 !!! note
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -243,7 +243,7 @@ nav:
         - DROP INDEX: 3.ngql-guide/14.native-index-statements/6.drop-native-index.md
 
       - Full-text index statements:
-        - Index overview: 3.ngql-guide/14.native-index-statements/README.md
+#        - Index overview: 3.ngql-guide/14.native-index-statements/README.md
         - Full-text restrictions: 4.deployment-and-installation/6.deploy-text-based-index/1.text-based-index-restrictions.md
         - Deploy Elasticsearch cluster: 4.deployment-and-installation/6.deploy-text-based-index/2.deploy-es.md
         - Deploy Raft Listener cluster: 4.deployment-and-installation/6.deploy-text-based-index/3.deploy-listener.md
@@ -260,6 +260,7 @@ nav:
         # - CONFIG syntax: 3.ngql-guide/18.operation-and-maintenance-statements/1.configs-syntax.md
         - BALANCE syntax: 3.ngql-guide/18.operation-and-maintenance-statements/2.balance-syntax.md
         - Job statements: 3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md
+        - Kill queries: 3.ngql-guide/18.operation-and-maintenance-statements/6.kill-query.md
 
   - Deployment and installation:
       - Resource preparations: 4.deployment-and-installation/1.resource-preparations.md
@@ -303,6 +304,17 @@ nav:
   - Service Tuning:
     - Compaction: 8.service-tuning/compaction.md
     - Storage load balance: 8.service-tuning/load-balance.md
+    - Modeling suggestions: 8.service-tuning/2.graph-modeling.md
+    - System design suggestions: 8.service-tuning/3.system-design.md
+    - Execution plan: 8.service-tuning/4.plan.md
+    - Processing super vertices: 8.service-tuning/super-node.md
+
+  - Client:
+    - Clients overview: 14.client/1.nebula-client.md
+    - Nebula CPP: 14.client/3.nebula-cpp-client.md
+    - Nebula Java: 14.client/4.nebula-java-client.md
+    - Nebula Python: 14.client/5.nebula-python-client.md
+    - Nebula Go: 14.client/6.nebula-go-client.md
 
   - Nebula Graph Studio:
     - Change Log: nebula-studio/about-studio/st-ug-release-note.md