Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the guide to install atmos using aqua #720

Merged
merged 2 commits into from
Oct 15, 2024

Conversation

suzuki-shunsuke
Copy link
Contributor

@suzuki-shunsuke suzuki-shunsuke commented Oct 14, 2024

what

Add the guide to install atmos using aqua.

why

aqua is a CLI Version Manager written in Go.
aqua supports various tools including atmos, Terraform, Helm, Helmfile.

Confirmation

I have launched the webserver on my laptop according to the guide.

image

references

Summary by CodeRabbit

  • New Features

    • Introduced a new installation method for Atmos using the aqua CLI version manager.
    • Added a dedicated tab in the installation guide for aqua, including instructions for setup and usage.
  • Documentation

    • Updated the "Install Atmos" document to enhance user guidance on installation options.

@suzuki-shunsuke suzuki-shunsuke requested review from a team as code owners October 14, 2024 04:26
@suzuki-shunsuke suzuki-shunsuke marked this pull request as draft October 14, 2024 04:26
@osterman osterman added the no-release Do not create a new release (wait for additional code changes) label Oct 14, 2024
@suzuki-shunsuke suzuki-shunsuke marked this pull request as ready for review October 14, 2024 04:35
Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The document "Install Atmos" has been updated to introduce a new installation method using the aqua CLI version manager. This method is presented within a new <TabItem> labeled "aqua," which includes instructions for creating an aqua.yaml file and executing the installation command. A note is also included for users who need to install aqua. The overall structure of the document remains consistent with existing installation options.

Changes

File Path Change Summary
website/docs/quick-start/install-atmos.mdx Added new <TabItem> for aqua installation method, including instructions for aqua.yaml and installation command.

Suggested reviewers

  • gberenice
  • kevcube

Poem

In the land of code where rabbits play,
A new path to install has come our way.
With aqua in hand, hop along with glee,
For seamless installs, as easy as can be!
So gather your tools, let’s code and cheer,
With every new method, our joy draws near! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between fd42e67 and 7e4a95d.

📒 Files selected for processing (1)
  • website/docs/quick-start/install-atmos.mdx (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
website/docs/quick-start/install-atmos.mdx (1)

198-219: Excellent addition of the aqua installation method!

The new section for installing Atmos using aqua is well-structured and consistent with other installation methods in the document. Great job on implementing the suggestions from the previous review:

  1. You've added a clear explanation of what aqua is and its benefits, which helps users make an informed decision.
  2. The step-by-step instructions are concise and easy to follow.
  3. The note about installing aqua is helpful for users who don't have it yet.

The formatting and structure align well with the rest of the document, maintaining consistency and readability.


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 94e0226 and fd42e67.

📒 Files selected for processing (1)
  • website/docs/quick-start/install-atmos.mdx (1 hunks)
🧰 Additional context used

website/docs/quick-start/install-atmos.mdx Outdated Show resolved Hide resolved
@osterman osterman merged commit cfa2f21 into cloudposse:main Oct 15, 2024
21 of 22 checks passed
@suzuki-shunsuke suzuki-shunsuke deleted the install-atmos-using-aqua branch October 15, 2024 21:48
Copy link

These changes were released in v1.91.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-release Do not create a new release (wait for additional code changes)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants