Skip to content

Commit

Permalink
🐛 📝 Fix broken links in document files
Browse files Browse the repository at this point in the history
Signed-off-by: vankichi <[email protected]>
  • Loading branch information
vankichi committed Sep 11, 2024
1 parent c3c5765 commit 07bb715
Show file tree
Hide file tree
Showing 22 changed files with 507 additions and 39 deletions.
1 change: 1 addition & 0 deletions Makefile.d/k8s.mk
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ k8s/manifest/update: \
--set manager.index.saver.enabled=true \
--set manager.index.creator.enabled=true \
--set manager.index.corrector.enabled=true \
--set gateway.mirror.enabled=true \
--output-dir $(TEMP_DIR) \
charts/vald
mkdir -p k8s/gateway
Expand Down
6 changes: 3 additions & 3 deletions docs/api/insert.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Inset RPC is the method to add a new single vector.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -226,7 +226,7 @@ It's the recommended method to insert a large number of vectors.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -349,7 +349,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down
6 changes: 3 additions & 3 deletions docs/api/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Exists RPC is the method to check that a vector exists in the `vald-agent`.
| 5 | NOT_FOUND |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -148,7 +148,7 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v
| 5 | NOT_FOUND |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -242,7 +242,7 @@ Each Upsert request and response are independent.
| 5 | NOT_FOUND |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down
8 changes: 4 additions & 4 deletions docs/api/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Remove RPC is the method to remove a single vector.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -222,7 +222,7 @@ RemoveByTimestamp RPC is the method to remove vectors based on timestamp.
| 5 | NOT_FOUND |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -344,7 +344,7 @@ It's the recommended method to remove a large number of vectors.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -465,7 +465,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down
24 changes: 12 additions & 12 deletions docs/api/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Search RPC is the method to search vector(s) similar to the request vector.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -267,7 +267,7 @@ The vector with the same requested ID should be indexed into the `vald-agent` be
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -403,7 +403,7 @@ Each Search request and response are independent.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -539,7 +539,7 @@ Each SearchByID request and response are independent.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -684,7 +684,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -830,7 +830,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -946,7 +946,7 @@ LinearSearch RPC is the method to linear search vector(s) similar to the request
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -1064,7 +1064,7 @@ You will get a `NOT_FOUND` error if the vector isn't stored.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -1196,7 +1196,7 @@ Each LinearSearch request and response are independent.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -1328,7 +1328,7 @@ Each LinearSearchByID request and response are independent.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -1469,7 +1469,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -1611,7 +1611,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down
6 changes: 3 additions & 3 deletions docs/api/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Update RPC is the method to update a single vector.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -231,7 +231,7 @@ It's the recommended method to update the large amount of vectors.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -357,7 +357,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down
6 changes: 3 additions & 3 deletions docs/api/upsert.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Upsert RPC is the method to update the inserted vector to a new single vector or
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -232,7 +232,7 @@ It’s the recommended method to upsert a large number of vectors.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down Expand Up @@ -356,7 +356,7 @@ Please be careful that the size of the request exceeds the limit.
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](./status.md) for more details.
Please refer to [Response Status Code](../status.md) for more details.

### Troubleshooting

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/coding-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -1407,4 +1407,4 @@ Since each package has its purpose, we decided to apply different strategies to

For the rest of the `./pkg` packages, we decided to implement the unit test for the exported function only.

Please follow the [unit test guideline](./unit-test-guideline.md) for more details on how to implement good unit test.
Please follow the [unit test guideline](../unit-test-guideline.md) for more details on how to implement good unit test.
4 changes: 2 additions & 2 deletions docs/performance/continuous-benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ And, Benchmark Operator also applies it to the Kubernetes cluster based on `Vald
| search_config | | request config for search job | object | ref: [config](#search-cfg-props) |
| remove_config | | request config for remove job | object | ref: [config](#remove-cfg-props) |
| object_config | | request config for object job | object | ref: [config](#object-cfg-props) |
| client_config | | gRPC client config for running benchmark job<BR>Tune if can not getting the expected performance with default config. | object | ref: [defaults.grpc](https://github.com/vdaas/vald/blob/main/charts/vald/README.md) |
| server_config | | server config for benchmark job pod<BR>Tune if can not getting the expected performance with default config. | object | ref: [defaults.server_config](https://github.com/vdaas/vald/blob/main/charts/vald/README.md) |
| client_config | | gRPC client config for running benchmark job<BR>Tune if can not getting the expected performance with default config. | object | ref: [defaults.grpc](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) |
| server_config | | server config for benchmark job pod<BR>Tune if can not getting the expected performance with default config. | object | ref: [defaults.server_config](https://github.com/vdaas/vald/blob/main/charts/vald/values.yaml) |

<a id="target-prop" />

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting/client-side.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ Please check your CPU information.

- [Provisioning Troubleshooting](../troubleshooting/provisioning.md)
- [API Status](../api/status.md)
- [FAQ](../support/FAQ.md)
- [FAQ](/docs/support/faq)
2 changes: 1 addition & 1 deletion docs/tutorial/get-started-with-faiss-agent.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Get Started

This tutorial is for those who have already completed [Get Started](https://github.com/vdaas/vald/blob/main/docs/tutorial/get-started.md).
This tutorial is for those who have already completed [Get Started](../tutorial/get-started.md).
Please refer to Prepare the Kubernetes Cluster and others there.

## Deploy Vald on Kubernetes Cluster
Expand Down
10 changes: 5 additions & 5 deletions docs/tutorial/vald-multicluster-on-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n
git clone https://github.com/vdaas/vald.git && cd vald
```

2. Deploy on the `vald-01` Namespace using [dev-vald-01.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-01.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml)
2. Deploy on the `vald-01` Namespace using [dev-vald-01.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-01.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml)

```bash
helm install vald-cluster-01 charts/vald \
Expand All @@ -97,7 +97,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n
-n vald-01
```

3. Deploy on the `vald-02` Namespace using [dev-vald-02.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-02.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml)
3. Deploy on the `vald-02` Namespace using [dev-vald-02.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-02.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml)

```bash
helm install vald-cluster-02 charts/vald \
Expand All @@ -106,7 +106,7 @@ In this section, you will deploy three Vald clusters consisting of `vald-agent-n
-n vald-02
```

4. Deploy on the `vald-03` Namespace using [dev-vald-03.yaml](https://github.com/vdaas/vald/blob/feature/mirror-gateway-definition/charts/vald/values/multi-vald/dev-vald-03.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml)
4. Deploy on the `vald-03` Namespace using [dev-vald-03.yaml](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/dev-vald-03.yaml) and [values.yaml](https://github.com/vdaas/vald/blob/main/example/helm/values.yaml)

```bash
helm install vald-cluster-03 charts/vald \
Expand Down Expand Up @@ -194,7 +194,7 @@ It requires applying the `ValdMirrorTarget` Custom Resource to the one Namespace

When applied successfully, the destination information is automatically created on other Namespaces when interconnected with each `vald-mirror-gateway`.

This tutorial will deploy the [ValdMirrorTarget](https://github.com/vdaas/vald/tree/main/charts/vald/values/mirror-target.yaml) Custom Resource to the `vald-03` Namespace with the following command.
This tutorial will deploy the [ValdMirrorTarget](https://github.com/vdaas/vald/blob/main/charts/vald/values/multi-vald/mirror-target.yaml) Custom Resource to the `vald-03` Namespace with the following command.

```bash
kubectl apply -f ./charts/vald/values/multi-vald/mirror-target.yaml -n vald-03
Expand Down Expand Up @@ -255,7 +255,7 @@ If you are interested, please refer to [SDKs](https://vald.vdaas.org/docs/user-

3. Run Example

We use [example/client/mirror/main.go](https://github.com/vdaas/vald/blob/feature/mirror-gateway-example/example/client/mirror/main.go) to run the example.
We use [example/client/mirror/main.go](https://github.com/vdaas/vald/blob/main/example/client/mirror/main.go) to run the example.

This example will insert and index 400 vectors into the Vald cluster from the Fashion-MNIST dataset via [gRPC](https://grpc.io/).
And then, after waiting for indexing, it will request to search the nearest vector 10 times to all Vald clusters. You will get the 10 nearest neighbor vectors for each search query.
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/cluster-role-binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ In this section, we will describe how to configure it and how to customize these

### Cluster role configuration for Vald Mirror Gateway

By looking at the [cluster role configuration](https://github.com/vdaas/vald/blob/main/k8s/gatewat/mirror/clusterrole.yaml), the access right of the following resources are granted to the cluster role `gateway-mirror`.
By looking at the [cluster role configuration](https://github.com/vdaas/vald/blob/main/k8s/gateway/mirror/clusterrole.yaml), the access right of the following resources are granted to the cluster role `gateway-mirror`.

```yaml
apiVersion: rbac.authorization.k8s.io/v1
Expand Down
Loading

0 comments on commit 07bb715

Please sign in to comment.