-
Notifications
You must be signed in to change notification settings - Fork 129
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: reference the Mutiny workshop examples
- Loading branch information
Showing
5 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
tags: | ||
- tutorial | ||
- beginner | ||
--- | ||
|
||
# Go further with the Mutiny workshop! | ||
|
||
One great option to teach yourself Mutiny is to go through the [Mutiny workshop examples](https://github.com/smallrye/smallrye-mutiny/tree/main/workshop-examples). | ||
|
||
These self-contained [JBang](https://jbang.dev/) scripts cover the main parts of the Mutiny APIs. | ||
|
||
It's a fun and easy way to discover Mutiny! | ||
|
||
Check out [https://github.com/smallrye/smallrye-mutiny/tree/main/workshop-examples](https://github.com/smallrye/smallrye-mutiny/tree/main/workshop-examples) to learn more. | ||
|
||
![Running a workshop sample](running-workshop-sample.png){ width="400" } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Mutiny workshop examples | ||
|
||
This project contains learning examples for Mutiny, covering a wide range of topics such as the basics, transformations, error recovery and more. | ||
|
||
## Structure | ||
|
||
The examples are found in `src/main/java` and use a non-conventional file naming strategy. | ||
|
||
For instance you will find the failure handling examples in `_04_failures` where `_04_Uni_Failure_Retry.java` holds one such example. | ||
|
||
This naming scheme is not usual for Java programs, but it makes for a great way to organize files 😄 | ||
|
||
## Running the examples | ||
|
||
Each file is a self-contained class with a `main` method. | ||
|
||
A friendly option is to open the Maven project in your favorite IDE, then run the `main` method of each example of interest. | ||
|
||
The other option is to use [JBang](https://www.jbang.dev/) as each example is a valid JBang script: | ||
|
||
```shell | ||
jbang src/main/java/_05_backpressure/_03_Visual_Drop.java | ||
``` | ||
|
||
What's more each file is Unix-executable, so you can also run as: | ||
|
||
```shell | ||
./src/main/java/_05_backpressure/_03_Visual_Drop.java | ||
``` |