Skip to content

Commit

Permalink
Fix broken links in the document files (#2611)
Browse files Browse the repository at this point in the history 
* 🐛 📝 Fix broken links in document files

Signed-off-by: vankichi <[email protected]>

* style: format code with Gofumpt and Prettier

This commit fixes the style issues introduced in 07bb715 according to the output
from Gofumpt and Prettier.

Details: #2611

---------

Signed-off-by: vankichi <[email protected]>
Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
  • Loading branch information
@vankichi @deepsource-autofix @vdaas-ci
2 people authored and vdaas-ci committed Sep 11, 2024
1 parent d6f600a commit 40fd77e
Show file tree
Hide file tree
Showing 22 changed files with 523 additions and 55 deletions.
1 change: 1 addition & 0 deletions Makefile.d/k8s.mk
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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
View file
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.
Loading

0 comments on commit 40fd77e

Please sign in to comment.