include note about java version

[ken-zlai]

Summary

Checklist

• Added Unit Tests
• Covered by existing CI
• Integration tested
• Documentation update

Summary by CodeRabbit

• Documentation
  • Updated the README to enhance clarity and readability.
  • Added new installation requirements for appropriate Java, Scala, and Python versions alongside Docker.
  • Reformatted notes for improved visibility.

[coderabbitai]

Walkthrough

The changes involve updates to the docker-init/README.md file, enhancing the clarity of installation requirements for setting up Docker containers. The documentation now includes a reformatted note regarding Docker installation, improving readability, and specifies that users must install appropriate Java, Scala, and Python versions as per the instructions in devnotes.md. The overall structure and content remain unchanged, with no modifications to the instructions or commands for building and running the Docker containers.

Changes

File	Change Summary
docker-init/README.md	Updated documentation for clarity, reformatted Docker installation note, added requirement for Java, Scala, and Python versions.

Possibly related PRs

• Docker init #20: The changes in the docker-init/README.md file in this PR relate directly to the updates made in the same file in PR Docker init #20, which also involves documentation enhancements for Docker setup and requirements.
• chore: update devnotes #97: This PR updates devnotes.md to include installation instructions for Java, Scala, and Python versions, which aligns with the new requirement introduced in the main PR regarding the installation of these software versions.

Suggested reviewers

• piyush-zlai
• chewy-zlai

🐰 In the garden, bright and fair,
Changes made with utmost care.
Docker's setup, clear as day,
JDKs added, hip-hip-hooray!
Read the notes, they shine so bright,
Happy coding, day and night! 🌼

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8177fde and b4ec8ea.

📒 Files selected for processing (1)

• docker-init/README.md (3 hunks)

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

• docker-init/README.md

---

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

[tchow-zlai]

maybe just fix it to what we have in the dev notes? https://github.com/zipline-ai/chronon/blob/main/devnotes.md#install-appropriate-java-scala-and-python-versions

[ken-zlai]

i've linked it to the devnotes section