Updated minikube cluster deployment documentation

[taeng0204]

Modify the content of existing documentation that differs from the current yorkie version Changed examples for testing yorkie cluster from CodePair to Quill in the yorkie-js-sdk

What this PR does / why we need it?

The docs for building a yorkie cluster with minikube are expired or missing.
This PR starts by fixing those, and then moves to the Quill example in the yorkie-js-sdk instead of the Code Pair example, which is too heavy for testing clusters.

Any background context you want to provide?

The dependencies for minikube, helm, and istio are specified, but I'm wondering if it's right to not specify the dependencies for npm, pnpm, etc. to run the yorkie-js-sdk.

• Pros of specifying: smoother testing
• Cons of specification: this documentation is more focused on the core topic of Yorkie Cluster

What are the relevant tickets?

Fixes #156

Checklist

• Added relevant tests or not required
• Didn't break anything

Summary by CodeRabbit

• Documentation
  • Updated installation and testing documentation for the Yorkie cluster on Minikube.
  • Replaced references from "CodePair" to "Quill" for clarity on the collaborative code editor.
  • Revised commands and environment variable configurations to reflect updates for Quill.
  • Enhanced accuracy in output messages related to starting the collaborative tool.

[CLAassistant]

All committers have signed the CLA.

[coderabbitai]

Walkthrough

The documentation updates streamline the installation and testing processes for the Yorkie cluster on Minikube by replacing references to "CodePair" with "Quill," a new collaborative code editor. Changes include updated environment variable configurations, revised command instructions, and a focus on ensuring users have accurate guidance for using Quill effectively.

Changes

File Path	Change Summary
docs/self-hosted-server/minikube.mdx	Updated references from "CodePair" to "Quill," altered environment variable from VITE_APP_YORKIE_RPC_ADDR to VITE_YORKIE_API_ADDR, and revised command instructions for cloning and running Quill.

Assessment against linked issues

Objective	Addressed	Explanation
Update environment variable to VITE_YORKIE_API_ADDR ( #156 )	✅
Reference the README for setup instructions ( #156 )	❌	README references were not explicitly updated.

🐇 In a world of code, we hop and play,
With Quill in hand, we lead the way.
From CodePair's shadow, we spring anew,
Collaborating bright, with a fresh point of view.
So let’s code together, let our spirits soar,
With each little change, we open new doors! 🌟

---

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 Configuration 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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e495750 and 5b6e36c.

Files selected for processing (1)

• docs/self-hosted-server/minikube.mdx (4 hunks)

Additional comments not posted (2)

docs/self-hosted-server/minikube.mdx (2)

11-11: Introduction update approved.

The introduction correctly reflects the change from CodePair to Quill for testing the Yorkie cluster.

---

230-281: Testing instructions update approved.

The instructions for testing with Quill are clear and accurately reflect the change from CodePair to Quill. Ensure that the environment variable VITE_YORKIE_API_ADDR is correctly set in the .env file.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5b6e36c and 615c7e5.

Files selected for processing (1)

• docs/self-hosted-server/minikube.mdx (4 hunks)

Files skipped from review as they are similar to previous changes (1)

• docs/self-hosted-server/minikube.mdx