diff --git a/docs/workshop.md b/docs/workshop.md index 0a46b08..6309c03 100644 --- a/docs/workshop.md +++ b/docs/workshop.md @@ -24,9 +24,46 @@ During this workshop we will cover: * Log management * GIT (conventional commits) -## Project overview +## Prerequisites +### :mortar_board: Skills + +| Skill | Level | +|----------------------------------------|---| +| [Java](https://www.oracle.com/java/) | novice | +| [Maven](https://www.maven.apache.org/) | novice | + +### :wrench: Tools +#### If you want to execute this workshop locally +You **MUST** have set up these tools first: +* [Java 21+](https://adoptium.net/temurin/releases/?version=21) +* [Maven 3.9](https://www.maven.apache.org/) +* [Docker](https://docs.docker.com/) & [Docker compose](https://docs.docker.com/compose/) +* Any IDE ([IntelliJ IDEA](https://www.jetbrains.com/idea), [VSCode](https://code.visualstudio.com/), [Netbeans](https://netbeans.apache.org/),...) you want + +Here are commands to validate your environment: + +**Java** + +```jshelllanguage +java -version +openjdk version "21.0.1" 2023-10-17 LTS +OpenJDK Runtime Environment Temurin-21.0.1+12 (build 21.0.1+12-LTS) +OpenJDK 64-Bit Server VM Temurin-21.0.1+12 (build 21.0.1+12-LTS, mixed mode, sharing) +``` + +**Maven** + +```jshelllanguage +❯ mvn --version + Apache Maven 3.9.9 (8e8579a9e76f7d015ee5ec7bfcdc97d260186937) + Maven home: /home/alexandre/.sdkman/candidates/maven/current + Java version: 21.0.4, vendor: Eclipse Adoptium, runtime: /home/alexandre/.sdkman/candidates/java/21.0.4-tem + Default locale: en, platform encoding: UTF-8 + OS name: "linux", version: "5.15.153.1-microsoft-standard-wsl2", arch: "amd64", family: "unix" +``` + ## Clean code Clean code is a