fix indent and link

[kmrmt]

Description

SSIA

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
  • Corrected indentation in code snippet within the "Get Started" tutorial.
  • Updated reference link in the "Read Replica and Rotator" user guide for better clarity.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates involve minor adjustments in two documentation files. In get-started.md, an indentation issue within a code snippet was corrected. In read-replica-and-rotator.md, a reference link in a Helm deployment scenario was updated for clarity. These changes ensure better readability and accuracy in the documentation without affecting any exported or public entities.

Changes

Files	Change Summary
docs/tutorial/get-started.md	Adjusted the indentation of the glg.Fatal(err) statement within a code snippet.
docs/user-guides/read-replica-and-rotator.md	Updated a reference link in a Helm deployment scenario to ensure proper navigation.

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (8)

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

Line range hint 15-15: Add alt text to the image for accessibility.

- <img src="../../assets/docs/tutorial/getstarted.svg" />
+ <img src="../../assets/docs/tutorial/getstarted.svg" alt="Vald Architecture Overview" />

---

Line range hint 19-19: Correct the case of anchor links to match their targets.

- 1. [Check and Satisfy the Requirements](#Requirements)
- 1. [Prepare Kubernetes Cluster](#Prepare-the-Kubernetes-Cluster)
- 1. [Deploy Vald on Kubernetes Cluster](#Deploy-Vald-on-Kubernetes-Cluster)
- 1. [Run Example Code](#Run-Example-Code)
- 1. [Cleanup](#Cleanup)
+ 1. [Check and Satisfy the Requirements](#requirements)
+ 1. [Prepare Kubernetes Cluster](#prepare-the-kubernetes-cluster)
+ 1. [Deploy Vald on Kubernetes Cluster](#deploy-vald-on-kubernetes-cluster)
+ 1. [Run Example Code](#run-example-code)
+ 1. [Cleanup](#cleanup)

Also applies to: 20-20, 21-21, 22-22, 23-23

---

Line range hint 30-30: Improve grammatical structure for clarity.

- libhdf5 (_only required for get started_)
+ libhdf5 (_only required to get started_)

---

Line range hint 65-65: Enhance the expression for better clarity.

- Please make sure these functions are available.
+ Please ensure these functions are enabled.

---

Line range hint 145-145: Add missing possessive apostrophe for clarity.

- you can check the Vald's pods status following command.
+ you can check the Vald's pods' status with the following command.

---

Line range hint 205-205: Correct preposition for grammatical accuracy.

- for requesting to Vald cluster.
+ for making requests to the Vald cluster.

---

Line range hint 317-317: Simplify the expression for conciseness.

- list of ids when loading is completed with success.
+ list of ids when loading is successfully completed.

---

Line range hint 463-463: Elevate the tone for a more formal expression.

- You completely entered the Vald World!
+ You have now fully entered the world of Vald!

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9f5742c and 262dda9.

Files selected for processing (2)

• docs/tutorial/get-started.md (1 hunks)
• docs/user-guides/read-replica-and-rotator.md (1 hunks)

Files skipped from review due to trivial changes (1)

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

[hlts2]

LGTM!