Update Docs: AWS EKS doc #170
Conversation
WalkthroughThe changes primarily involve updates to documentation regarding the Yorkie collaborative editing tool. Key modifications include renaming references from "CodePair" to "Quill Example" and adjusting Helm installation commands to reflect new naming conventions for AWS settings. The testing section now emphasizes the use of the "yorkie-js-sdk" and updates commands related to repository structure and environment variables. Additionally, instructions for starting the application have been revised to use "Quill" and the local server address has been changed. Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
docs/self-hosted-server/aws-eks.mdx (3)
110-111: LGTM: Updated Helm chart configurationThe change from
ingress.alb.enabledtoingress.awsAlb.enabledcorrectly aligns with the PR objectives and likely reflects an update in the Helm chart's configuration options.Consider adding a brief comment explaining the reason for this change, such as:
+ # Note: `ingress.awsAlb.enabled` is used instead of `ingress.alb.enabled` due to recent changes in the Helm chart configuration --set ingress.awsAlb.enabled=true \ --set ingress.awsAlb.certArn={YOUR_CERTIFICATE_ARN}This would help users understand why the command differs from potentially outdated external resources they might encounter.
Also applies to: 119-120
171-173: LGTM: Updated testing instructionsThe changes accurately reflect the switch from "CodePair" to "yorkie-js-sdk" as mentioned in the PR objectives. The updated repository URL and installation commands provide clear and accurate instructions for users.
Consider adding a brief note about the use of
pnpminstead ofnpm, as some users might not be familiar with it. For example:+ # Note: This project uses pnpm as the package manager. If you don't have pnpm installed, you can install it with: npm install -g pnpm $ pnpm iThis would help users who are not familiar with
pnpmto set up their environment correctly.Also applies to: 176-176, 179-183, 186-190
192-192: LGTM: Updated environment variable and start commandThe changes to the environment variable name, start command, and command output accurately reflect the updates in the project structure and tooling. These updates align well with the PR objectives and previous changes in the document.
To improve clarity, consider adding a brief explanation of the change in the environment variable name. For example:
- VITE_APP_YORKIE_RPC_ADDR=http://<YOUR_API_DOMAIN_NAME or IP_ADDRESS> + # Note: The environment variable has been renamed to better reflect its purpose + VITE_YORKIE_API_ADDR=http://<YOUR_API_DOMAIN_NAME or IP_ADDRESS>This would help users understand the reason for the change and prevent confusion if they encounter older documentation or examples.
Also applies to: 195-199, 201-213
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- docs/self-hosted-server/aws-eks.mdx (3 hunks)
🔇 Additional comments (5)
docs/self-hosted-server/aws-eks.mdx (5)
11-11: LGTM: Updated example referenceThe change from "CodePair" to "Quill Example" accurately reflects the updated test example mentioned in the PR objectives. This improves clarity for users following the documentation.
162-166: LGTM: Updated pod status outputThe updated output for the
kubectl get podscommand accurately reflects the expected state of the Yorkie cluster after installation. This helps users verify that their installation was successful.
216-219: LGTM: Updated access instructions and added reference to more examplesThe changes provide clear instructions for accessing the Quill example and helpfully direct users to additional examples in the yorkie-js-sdk repository. This addition enhances the documentation by offering users more resources to explore Yorkie's capabilities.
223-223: LGTM: Added conclusion to installation and testing sectionThe addition of this line provides a clear conclusion to the installation and testing process. It helps users understand that they have successfully completed the main steps of the tutorial.
Line range hint
1-219: Overall: Excellent updates to the AWS EKS Installation documentationThe changes made to this documentation file significantly improve its accuracy and usability. The updates consistently reflect the switch from CodePair to the yorkie-js-sdk with vanilla-quill, as stated in the PR objectives. The Helm chart configuration corrections and the detailed instructions for testing the Yorkie cluster provide users with a clear, up-to-date guide for installation and usage.
Key improvements include:
- Updated references to the new example (Quill) throughout the document.
- Corrected Helm CLI commands with the new
ingress.awsAlb.enabledoption.- Detailed and accurate instructions for testing the Yorkie cluster using yorkie-js-sdk.
- Updated environment variable names and command outputs to reflect current project structure.
- Added references to additional examples, enhancing the learning resources for users.
These changes collectively result in a more reliable and comprehensive guide for users setting up Yorkie on AWS EKS.
What this PR does / why we need it?
Modify the content of AWS EKS doc.
ingress.alb=>ingress.awsAlbin the Helm cli command--set.Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit