Skip to content

Commit cff92a6

Browse files
authored
include note about java version (#104)
## Summary ## Checklist - [ ] Added Unit Tests - [ ] Covered by existing CI - [ ] Integration tested - [ ] Documentation update <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## 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. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent cb0309e commit cff92a6

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docker-init/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
This directory holds code to setup docker containers for dynamoDB, a spark master, and a spark worker. It also creates a container which contains a parquet table with example data containing anomolies. To start, run:
44

5-
> [!NOTE]
6-
> Make sure you have `docker>=20.10` installed.
7-
5+
> **Note**
6+
> Make sure you have `docker >= 20.10` installed.
7+
> Install appropriate java, scala, and python versions following the instructions in [devnotes.md](../devnotes.md#install-appropriate-java-scala-and-python-versions).
88
99
```bash
1010
$ cd chronon
@@ -16,6 +16,7 @@ app-1 | [info] 2024-09-30 20:47:56,665 [main] INFO play.core.server.P
1616

1717
The build script will build the relevant Chronon modules (Spark, Frontend, Hub) and then trigger the docker container build. While iterating, you can selectively
1818
build modules you care about to speed your dev loop. For example to only rebuild Spark modules:
19+
1920
```bash
2021
$ ./docker-init/build.sh --spark
2122
Building Spark modules...
@@ -25,6 +26,7 @@ app-1 | [info] 2024-09-30 20:47:56,665 [main] INFO play.core.server.P
2526
```
2627

2728
If you'd like to start up the docker containers without re-building any code:
29+
2830
```bash
2931
$ docker compose -f docker-init/compose.yaml up
3032
```

0 commit comments

Comments
 (0)