Spring/spring-shell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Migrate docs shell samples to asciinema

Browse Source 
- Update antora settings
- Move cast files and remove old ones
- Switch shell svg's to asciinema
- Fixes #884
This commit is contained in:
Janne Valkealahti
2023-10-14 15:45:09 +01:00
parent 52b242dcbf
commit 860c8dcb93
26 changed files with 49 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
spring-shell-docs/modules/ROOT/pages/components/flow/index.adoc
View File

@@ -1,7 +1,7 @@
[[using-shell-components-flow]]
= Flow
ifndef::snippets[:snippets: ../../test/java/org/springframework/shell/docs]
ifndef::snippets[:snippets: ../../../../../src/test/java/org/springframework/shell/docs]
When you use xref:components/ui/index.adoc[Flow Components] to build something that involves
use of a multiple components, your implementation may become a bit cluttered.
@@ -16,7 +16,10 @@ The following listings show examples of flows and their output in a shell:
include::{snippets}/FlowComponentSnippets.java[tag=snippet1]
----
image::component-flow-showcase-1.svg[text input]
[asciinema,rows=15]
----
include::example$component-flow-showcase-1.cast[]
----
Normal execution order of a components is same as defined with a builder. It's
possible to conditionally choose where to jump in a flow by using a `next`
@@ -28,7 +31,11 @@ or doesn't exist flow is essentially stopped right there.
include::{snippets}/FlowComponentSnippets.java[tag=snippet2]
----
image::component-flow-conditional-1.svg[text input]
[asciinema,rows=11]
----
include::example$component-flow-conditional-1.cast[]
----
TIP: The result from running a flow returns `ComponentFlowResult`, which you can
use to do further actions.