Backport docs updates to release/v1.7

[hlts2]

Description

This PR contains the following PR commits

• 529e3d0
• 8a36249
• 1752537
• a1ed3ff
• 11fd9c5
• 9f5742c

Related Issue

Versions

• Go Version: 1.22.3
• Rust Version: 1.77.2
• Docker Version: 20.10.8
• Kubernetes Version: v1.30.0
• NGT Version: 2.2.1

Checklist

• I have read the CONTRIBUTING document and completed our CLA agreement.
• I have checked open Pull Requests for the similar feature or fixes?

Special notes for your reviewer

Summary by CodeRabbit

• Documentation
  • Added a "Status Code" section to enhance clarity on status codes used within the service.
  • Reorganized headers in remove.md to improve content structure.
  • Updated headings for MultiSearchByID RPC and MultiLinearSearchByID RPC for better readability.
  • Enhanced accessibility by adding an alt attribute to an image and updated URL references.
  • Corrected indentation in a Go code snippet for better error handling guidance.
  • Improved readability by converting a markdown link to an HTML link and updating reference links.

[coderabbitai]

Walkthrough

This update improves documentation clarity and structure across multiple files. Key changes include adding status code information, reorganizing headings and sections, enhancing accessibility, and correcting code snippets and link formats.

Changes

Files	Change Summary
docs/api/filter-gateway.md	Added a new section for "Status Code" with codes and descriptions.
docs/api/remove.md	Changed "Input" section header to a subsection for better content structure.
docs/api/search.md	Upgraded headings for MultiSearchByID and MultiLinearSearchByID RPC methods.
docs/overview/component/agent.md	Included alt attribute in img tag and updated URL to a versioned placeholder.
docs/tutorial/get-started.md	Fixed an indentation issue in the Go code snippet related to error handling.
docs/user-guides/read-replica-and-rotator.md	Updated hyperlink reference from markdown to HTML link and modified the reference link for deployment.

Sequence Diagram(s)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[vdaas-ci]

[CHATOPS:HELP] ChatOps commands.

• 🙆‍♀️ /approve - approve
• 🍱 /format - format codes and add licenses
• ✅ /gen-test - generate test codes
• 🏷️ /label - add labels
• 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

[github-actions]

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

[github-actions]

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

[github-actions]

[LanguageTool] _{reported by reviewdog 🐶}
Unpaired symbol: ‘"’ seems to be missing (EN_UNPAIRED_QUOTES)
URL: https://languagetool.org/insights/post/punctuation-guide/#what-are-parentheses
Rule: https://community.languagetool.org/rule/show/EN_UNPAIRED_QUOTES?lang=en-US
Category: PUNCTUATION

[github-actions]

🚫 [documents testlint] <eslint.rules.en-spell> _{reported by reviewdog 🐶}
CANCELLED => CANCELED (en-spell)

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 02769f0 and c8d44b2.

Files selected for processing (6)

• docs/api/filter-gateway.md (1 hunks)
• docs/api/remove.md (1 hunks)
• docs/api/search.md (2 hunks)
• docs/overview/component/agent.md (1 hunks)
• docs/tutorial/get-started.md (1 hunks)
• docs/user-guides/read-replica-and-rotator.md (2 hunks)

Files skipped from review due to trivial changes (2)

• docs/api/search.md
• docs/user-guides/read-replica-and-rotator.md

Additional context used

LanguageTool

docs/overview/component/agent.md

[uncategorized] ~13-~13: The preposition ‘as’ seems more likely in this position. (AI_HYDRA_LEO_REPLACE_TO_AS)
Context: ...ponsible for: - Store index data along to the user requests - The store destina...

---

[uncategorized] ~93-~93: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_TO)
Context: ...cached for Faiss training. - Search - Get the nearest neighbor vectors of the req...

docs/tutorial/get-started.md

[style] ~65-~65: Consider using a different verb to strengthen your wording. (MAKE_SURE_ENSURE)
Context: ...cs-server) for running Vald.
Please make sure these functions are available.
The...

---

[uncategorized] ~145-~145: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...eploying Vald, you can check the Vald's pods status following command. ```bash ...

---

[style] ~317-~317: ‘with success’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITH_SUCCESS)
Context: ...s list of ids when loading is completed with success.

example ...

---

[style] ~463-~463: This phrasing can be overused. Try elevating your writing with a more formal alternative. (IF_YOU_WANT)
Context: ...You completely entered the Vald World! If you want, you can try other tutorials such as: ...

docs/api/remove.md

[uncategorized] ~67-~67: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ...--------------------------------------- | | id | string | | * ...

---

[uncategorized] ~171-~171: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ... | | :---: | :--------------------- | | Eq | Equal. | ...

---

[uncategorized] ~205-~205: The grammatical number of this noun doesn’t look right. Consider replacing it. (AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location ...

---

[style] ~245-~245: Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF)
Context: .... It's the recommended method to remove a large number of vectors. ### Input - the scheme of `p...

---

[uncategorized] ~288-~288: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ...--------------------------------------- | | id | string | | * ...

---

[uncategorized] ~423-~423: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ...--------------------------------------- | | id | string | | * ...

---

[uncategorized] ~446-~446: The grammatical number of this noun doesn’t look right. Consider replacing it. (AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
Context: ...d(Array[Object.Location]) | The list of Object.Location. | - Object.Location ...

docs/api/filter-gateway.md

[style] ~138-~138: Specify a number, remove phrase, or simply use “many” or “numerous” (LARGE_NUMBER_OF)
Context: .... It's the recommended method to insert a large number of objects. ```rpc service Filter { rpc...

---

[grammar] ~247-~247: “Google” is a proper noun and needs to be capitalized. (A_GOOGLE)
Context: ...ogle.rpc.Status | | the status of google RPC. | - Object.Loc...

---

[style] ~396-~396: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...d(Array[Object.Location]) | the list of Object.Location. | - Object.Location | field |...

---

[uncategorized] ~546-~546: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case. (AMOUNTOF_TO_NUMBEROF)
Context: ... recommended method to update the large amount of objects. ```rpc service Filter { ...

---

[grammar] ~656-~656: “Google” is a proper noun and needs to be capitalized. (A_GOOGLE)
Context: ...ogle.rpc.Status | | the status of google RPC. | - Object.Loc...

---

[style] ~811-~811: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...d(Array[Object.Location]) | the list of Object.Location. | - Object.Location | field |...

---

[grammar] ~1068-~1068: “Google” is a proper noun and needs to be capitalized. (A_GOOGLE)
Context: ...ogle.rpc.Status | | the status of google RPC. | - Object.Loc...

---

[style] ~1223-~1223: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...d(Array[Object.Location]) | the list of Object.Location. | - Object.Location | field |...

---

[grammar] ~1464-~1464: “Google” is a proper noun and needs to be capitalized. (A_GOOGLE)
Context: ...ogle.rpc.Status | | the status of google RPC | - Search.Response | f...

Markdownlint

docs/overview/component/agent.md

140-140: null (MD045, no-alt-text)
Images should have alternate text (alt text)

---

145-145: null (MD045, no-alt-text)
Images should have alternate text (alt text)

docs/tutorial/get-started.md

15-15: null (MD045, no-alt-text)
Images should have alternate text (alt text)

---

19-19: Expected: #requirements; Actual: #Requirements (MD051, link-fragments)
Link fragments should be valid

---

20-20: Expected: #prepare-the-kubernetes-cluster; Actual: #Prepare-the-Kubernetes-Cluster (MD051, link-fragments)
Link fragments should be valid

---

21-21: Expected: #deploy-vald-on-kubernetes-cluster; Actual: #Deploy-Vald-on-Kubernetes-Cluster (MD051, link-fragments)
Link fragments should be valid

---

22-22: Expected: #run-example-code; Actual: #Run-Example-Code (MD051, link-fragments)
Link fragments should be valid

---

23-23: Expected: #cleanup; Actual: #Cleanup (MD051, link-fragments)
Link fragments should be valid

Additional comments not posted (4)

docs/overview/component/agent.md (1)

77-77: Image Tag Accessibility Improvement Approved

The addition of the alt attribute improves accessibility and follows best web practices.

docs/tutorial/get-started.md (1)

446-446: Indentation Correction in Go Code Snippet Approved

Correcting the indentation enhances readability and maintains consistency across the documentation.

docs/api/remove.md (1)

Line range hint 1-1: Review of API Documentation

The API documentation for the Remove service appears complete and accurate. Ensure that all examples and descriptions are up-to-date with the current API specifications.

docs/api/filter-gateway.md (1)

1480-1490: Addition of Status Codes Section

The newly added "Status Code" section provides valuable information about the possible outcomes of API calls, enhancing the documentation's clarity and utility. This is a positive change as it helps developers understand expected behaviors and error handling more effectively.

[cloudflare-pages]

Deploying vald with    Cloudflare Pages

Latest commit:	c503c41
Status:	✅  Deploy successful!
Preview URL:	https://63652358.vald.pages.dev
Branch Preview URL:	https://backport-docs-release-v1-7.vald.pages.dev

View logs