Backport docs updates to release/v1.7 (#2521)

* fix links (#2500) Signed-off-by: Kosuke Morimoto <ksk@vdaas.org> * fix indent and link (#2501) Signed-off-by: Kosuke Morimoto <ksk@vdaas.org> * fix link (#2502) Signed-off-by: Kosuke Morimoto <ksk@vdaas.org> * fix typo (#2503) * fix typo (#2504) * change fixed version to replace string (#2506) * change fixed version to replace string Signed-off-by: Kosuke Morimoto <ksk@vdaas.org> * Update docs/overview/component/agent.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com> --------- Signed-off-by: Kosuke Morimoto <ksk@vdaas.org> Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Signed-off-by: Kosuke Morimoto <ksk@vdaas.org> Signed-off-by: Kosuke Morimoto <kou.morimoto@gmail.com> Co-authored-by: Kosuke Morimoto <ksk@vdaas.org> Co-authored-by: datelier <57349093+datelier@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
vdaas · Jun 25, 2024 · c6777f3 · c6777f3
1 parent ec079cd
commit c6777f3
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 8 deletions.
diff --git a/docs/api/filter-gateway.md b/docs/api/filter-gateway.md
@@ -1477,6 +1477,17 @@ service Filter {
     |    id    | string |       | the vector ID                                         |
     | distance | float  |       | the distance between result vector and request vector |
 
+### Status Code
+
+| code | desc.             |
+| :--: | :---------------- |
+|  0   | OK                |
+|  1   | CANCELLED         |
+|  3   | INVALID_ARGUMENT  |
+|  4   | DEADLINE_EXCEEDED |
+|  5   | NOT_FOUND         |
+|  13  | INTERNAL          |
+
 ## MultiSearch RPC
 
 MultiSearch RPC is the method to search objects with multiple objects in **1** request.

diff --git a/docs/api/remove.md b/docs/api/remove.md
@@ -369,7 +369,7 @@ gRPC has a message size limitation.<br>
 Please be careful that the size of the request exceeds the limit.
 </div>
 
-## Input
+### Input
 
 - the scheme of `payload.v1.Remove.MultiRequest`
 

diff --git a/docs/api/search.md b/docs/api/search.md
@@ -700,7 +700,7 @@ Here are some common reasons and how to resolve each error.
 | NOT_FOUND         | Search result is empty or insufficient to request result length.                                                | Send a request with another vector or set min_num to a smaller value.                    |
 | INTERNAL          | Target Vald cluster or network route has some critical error.                                                   | Check target Vald cluster first and check network route including ingress as second.     |
 
-### MultiSearchByID RPC
+## MultiSearchByID RPC
 
 MultiSearchByID RPC is the method to search vectors with multiple IDs in **1** request.
 
@@ -1485,7 +1485,7 @@ Here are some common reasons and how to resolve each error.
 | NOT_FOUND         | Search result is empty or insufficient to request result length.                                                | Send a request with another vector or set min_num to a smaller value.                    |
 | INTERNAL          | Target Vald cluster or network route has some critical error.                                                   | Check target Vald cluster first and check network route including ingress as second.     |
 
-### MultiLinearSearchByID RPC
+## MultiLinearSearchByID RPC
 
 MultiLinearSearchByID RPC is the method to linear search vectors with multiple IDs in **1** request.
 

diff --git a/docs/overview/component/agent.md b/docs/overview/component/agent.md
@@ -74,9 +74,9 @@ You have to wait to complete the CreateIndex and SaveIndex functions before sear
 
 This image shows the mechanism to create NGT index.
 
-<img src="../../../assets/docs/overview/component/agent/ngt.png" />
+<img src="../../../assets/docs/overview/component/agent/ngt.png" alt="NGT Index Creation Mechanism" />
 
-Please refer to [Go Doc](https://pkg.go.dev/github.com/vdaas/vald@v1.3.1/pkg/agent/core/ngt/service) for other functions.
+Please refer to [Go Doc](https://pkg.go.dev/github.com/vdaas/vald@VERSION@/pkg/agent/core/ngt/service) for other functions.
 
 #### Vald Agent Faiss
 

diff --git a/docs/tutorial/get-started.md b/docs/tutorial/get-started.md
@@ -443,7 +443,7 @@ If you are interested, please refer to [SDKs](../user-guides/sdks.md).<br>
           ```go
           _, err := client.Flush(ctx, &payload.Flush_Request{})
           if err != nil {
-             glg.Fatal(err)
+              glg.Fatal(err)
           }
           ```
 

diff --git a/docs/user-guides/read-replica-and-rotator.md b/docs/user-guides/read-replica-and-rotator.md
@@ -3,7 +3,7 @@
 Read replica enhances the search QPS (Queries Per Second) of the Vald cluster by deploying read-only agents in addition to the regular agents and distributing the requests among them. Read replica is deployed as Kubernetes deployments, and depending on the number of replicas (N), QPS increases by approximately 1.7 to 1.8 times \* N.
 
 <div class="notice">
-The increase in QPS is possible with sufficient infrastructure (see [Important notes](#important-notes)).
+The increase in QPS is possible with sufficient infrastructure (see <a href="#important-notes">Important notes</a>).
 </div>
 
 ## How to deploy read replica
@@ -14,7 +14,7 @@ The read replica is managed with a separate chart from the Vald cluster and is d
 
 ### When you deploy Vald with Helm command
 
-1. Edit `values.yaml` like below (Please refer to [deployment](deployment) for other fields.)
+1. Edit `values.yaml` like below (Please refer to [deployment](../user-guides/deployment.md) for other fields.)
 
    ```yaml
    agent: