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

feat: update gm tutorial to use kurtosis #414

Merged
merged 5 commits into from
Jul 2, 2024
Merged

feat: update gm tutorial to use kurtosis #414

merged 5 commits into from
Jul 2, 2024

Conversation

MSevey
Copy link
Contributor

@MSevey MSevey commented Jul 2, 2024

Overview

Blocked on rollkit/gm#110

Now that the GM rollup and frontend can be run all at once with the kurtosis package we can merge the two tutorials.

Summary by CodeRabbit

  • Documentation
    • Updated the GM world tutorial to use Kurtosis for managing services.
    • Revised commands for launching and interacting with the GM rollup using Kurtosis.

Copy link
Contributor

coderabbitai bot commented Jul 2, 2024

Note

Reviews paused

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Walkthrough

The tutorial for launching and managing the GM rollup has been updated to incorporate the use of Kurtosis. This includes instructions on managing services, launching the rollup, and interacting with it via Docker containers. The command for installation and verification steps have been revised to reflect the new approach using Kurtosis.

Changes

File Change Summary
tutorials/gm-world.md Updated tutorial to use Kurtosis for managing services, including launching GM rollup and verifying with Docker.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Kurtosis
    participant Docker
    participant Rollkit

    User ->> Kurtosis: Run installation command
    Kurtosis ->> Docker: Set up GM rollup environment
    Docker ->> Rollkit: Launch GM rollup containers
    User ->> Docker: Check running containers
    Docker ->> User: Display list of containers
Loading

Poem

In a land of code where services whirl,
Kurtosis guides, watch it unfurl,
Rollkit's GM, in containers' embrace,
All set up by commands with grace.
Docker hums, the magic unfurls,
Roll on, dear GM, in digital pearls. 🚀✨


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

Copy link
Contributor

github-actions bot commented Jul 2, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://rollkit.github.io/docs-preview/./pr-414/
on branch main at 2024-07-02 19:22 UTC

@MSevey MSevey marked this pull request as ready for review July 2, 2024 15:27
@MSevey MSevey requested a review from jcstein July 2, 2024 15:28
@MSevey MSevey enabled auto-merge (squash) July 2, 2024 15:28
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: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 59dc2c4 and 6467ac1.

Files selected for processing (1)
  • tutorials/gm-world.md (2 hunks)
Additional context used
LanguageTool
tutorials/gm-world.md

[uncategorized] ~32-~32: Possible missing comma found.
Context: ...es} As we moved into more advanced use cases we use [kurtosis](https://docs.kurtosis...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~34-~34: Possible missing comma found.
Context: ...ps://docs.kurtosis.com/install). Once installed you can verify the installation by runn...

(AI_HYDRA_LEO_MISSING_COMMA)


[grammar] ~46-~46: There is an agreement error between ‘have’ and ‘kurtosis’. Insert ‘a(n)’ or change the noun to plural.
Context: ...ollup {#start-your-rollup} Now that we have kurtosis, we can launch our GM rollup along with...

(PRP_VB_NN)

Markdownlint
tutorials/gm-world.md

32-32: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

Additional comments not posted (3)
tutorials/gm-world.md (3)

49-49: LGTM!

The command to launch the GM rollup using kurtosis is correct.


55-112: LGTM!

The updated output and docker commands correctly reflect the new process using kurtosis.


153-157: LGTM!

The command to enter the docker container is correct.

tutorials/gm-world.md Outdated Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
tutorials/gm-world.md Outdated Show resolved Hide resolved
@MSevey MSevey disabled auto-merge July 2, 2024 15:42
jcstein
jcstein previously approved these changes Jul 2, 2024
Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

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

utACK 🔥

@MSevey MSevey marked this pull request as draft July 2, 2024 15:42
Manav-Aggarwal
Manav-Aggarwal previously approved these changes Jul 2, 2024
tuxcanfly
tuxcanfly previously approved these changes Jul 2, 2024
Copy link
Contributor

@tuxcanfly tuxcanfly left a comment

Choose a reason for hiding this comment

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

OK. Minor typo.

tutorials/gm-world.md Outdated Show resolved Hide resolved
@MSevey
Copy link
Contributor Author

MSevey commented Jul 2, 2024

@coderabbitai resolve

@MSevey
Copy link
Contributor Author

MSevey commented Jul 2, 2024

@coderabbitai ignore

Copy link
Contributor

coderabbitai bot commented Jul 2, 2024

Actions performed

Comments resolved.

Copy link
Contributor

coderabbitai bot commented Jul 2, 2024

@coderabbitai ignore

Actions performed

Reviews paused.

@MSevey MSevey marked this pull request as ready for review July 2, 2024 19:20
@MSevey MSevey dismissed stale reviews from tuxcanfly and Manav-Aggarwal via f3d3643 July 2, 2024 19:20
@MSevey MSevey enabled auto-merge (squash) July 2, 2024 19:21
@MSevey MSevey merged commit 66f4ee0 into main Jul 2, 2024
4 checks passed
@MSevey MSevey deleted the kurtosis-gm branch July 2, 2024 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants