Skip to content

Commit

Permalink
Polish shell related docs
Browse files Browse the repository at this point in the history 
- Polishing some copied outputs as new spring-shell
  gives different output on some cases.
- Relates #4946
  • Loading branch information
@jvalkeal
jvalkeal committed Dec 9, 2022
1 parent f9d5806 commit e8b79bb
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 46 deletions.
2 changes: 1 addition & 1 deletion spring-cloud-dataflow-docs/src/main/asciidoc/configuration.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ Do not forget to target the Data Flow Server with the following command:
====
[source,bash]
----
dataflow:> dataflow config server https://localhost:8443/
dataflow:> dataflow config server --uri https://localhost:8443/
----
====

Expand Down
58 changes: 29 additions & 29 deletions spring-cloud-dataflow-docs/src/main/asciidoc/shell.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,14 @@ The following listing shows the output of the `help` command:
====
[source,bash]
----
! - Allows execution of operating system (OS) commands
clear - Clears the console
cls - Clears the console
date - Displays the local date and time
exit - Exits the shell
http get - Make GET request to http endpoint
http post - POST data to http endpoint
quit - Exits the shell
system properties - Shows the shells properties {JB - restore the apostrophe}
version - Displays shell version
Built-In Commands
help: Display help about available commands
stacktrace: Display the full stacktrace of the last error.
clear: Clear the shell screen.
quit, exit: Exit the shell.
history: Display or save the history of previously run commands
version: Show version info
script: Read and execute commands from a file.
----
====

Expand All @@ -77,26 +75,28 @@ Adding the name of the command to `help` shows additional information on how to
[source,bash]
----
dataflow:>help stream create
Keyword: stream create
Description: Create a new stream definition
Keyword: ** default **
Keyword: name
Help: the name to give to the stream
Mandatory: true
Default if specified: '__NULL__'
Default if unspecified: '__NULL__'
NAME
stream create - Create a new stream definition
Keyword: definition
Help: a stream definition, using the DSL (e.g. "http --port=9000 | hdfs")
Mandatory: true
Default if specified: '__NULL__'
Default if unspecified: '__NULL__'
SYNOPSIS
stream create [--name String] [--definition String] --description String --deploy boolean
Keyword: deploy
Help: whether to deploy the stream immediately
Mandatory: false
Default if specified: 'true'
Default if unspecified: 'false'
OPTIONS
--name String
the name to give to the stream
[Mandatory]
--definition String
a stream definition, using the DSL (e.g. "http --port=9000 | hdfs")
[Mandatory]
--description String
a short description about the stream
[Optional]
--deploy boolean
whether to deploy the stream immediately
[Optional, default = false]
----
====

Expand All @@ -109,7 +109,7 @@ You can complete the shell command options in the shell by pressing the `TAB` ke
[source,bash]
----
dataflow:>stream create --
stream create --definition stream create --name
--definition --deploy --description --name
----
====

Expand Down
47 changes: 31 additions & 16 deletions spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -451,11 +451,11 @@ The `stream info` command shows useful information about the stream, as shown (w
[source,bash]
----
dataflow:>stream info ticktock
╔═══════════╤═════════════════╤══════════╗
║Stream Name│Stream Definition│ Status ║
╠═══════════╪═════════════════╪══════════╣
║ticktock │time | log │undeployed║
╚═══════════╧═════════════════╧══════════╝
╔═══════════╤═════════════════╤═══════════╤══════════╗
║Stream Name│Stream Definition│Description│ Status ║
╠═══════════╪═════════════════╪═══════════╪══════════╣
║ticktock │time | log │ │undeployed║
╚═══════════╧═════════════════╧═══════════╧══════════╝
----
====

Expand Down Expand Up @@ -483,20 +483,31 @@ The following listing shows the exposed properties for the `time` application:
[source,bash,options="nowrap"]
----
dataflow:> app info --name time --type source
Information about source application 'time':
Version: '3.2.1':
Default application version: 'true':
Resource URI: maven://org.springframework.cloud.stream.app:time-source-rabbit:3.2.1
╔══════════════════════════════╤══════════════════════════════╤══════════════════════════════╤══════════════════════════════╗
║ Option Name │ Description │ Default │ Type ║
╠══════════════════════════════╪══════════════════════════════╪══════════════════════════════╪══════════════════════════════╣
║trigger.time-unit │The TimeUnit to apply to delay│<none> │java.util.concurrent.TimeUnit ║
║ │values. │ │ ║
║trigger.fixed-delay │Fixed delay for periodic │1 │java.lang.Integer ║
║ │triggers. │ │ ║
║trigger.cron │Cron expression value for the │<none> │java.lang.String ║
║ │Cron Trigger. │ │ ║
║trigger.initial-delay │Initial delay for periodic │0 │java.lang.Integer ║
║ │triggers. │ │ ║
║trigger.max-messages │Maximum messages per poll, -1 │1 │java.lang.Long ║
║ │means infinity. │ │ ║
║trigger.date-format │Format for the date value. │<none> │java.lang.String ║
║spring.integration.poller.max-│Maximum number of messages to │<none> │java.lang.Integer ║
║messages-per-poll │poll per polling cycle. │ │ ║
║spring.integration.poller.fixe│Polling rate period. Mutually │<none> │java.time.Duration ║
║d-rate │exclusive with 'fixedDelay' │ │ ║
║ │and 'cron'. │ │ ║
║spring.integration.poller.fixe│Polling delay period. Mutually│<none> │java.time.Duration ║
║d-delay │exclusive with 'cron' and │ │ ║
║ │'fixedRate'. │ │ ║
║spring.integration.poller.rece│How long to wait for messages │1s │java.time.Duration ║
║ive-timeout │on poll. │ │ ║
║spring.integration.poller.cron│Cron expression for polling. │<none> │java.lang.String ║
║ │Mutually exclusive with │ │ ║
║ │'fixedDelay' and 'fixedRate'. │ │ ║
║spring.integration.poller.init│Polling initial delay. Applied│<none> │java.time.Duration ║
║ial-delay │for 'fixedDelay' and │ │ ║
║ │'fixedRate'; ignored for │ │ ║
║ │'cron'. │ │ ║
║time.date-format │Format for the date value. │MM/dd/yy HH:mm:ss │java.lang.String ║
╚══════════════════════════════╧══════════════════════════════╧══════════════════════════════╧══════════════════════════════╝
----
====
Expand All @@ -507,6 +518,10 @@ The following listing shows the exposed properties for the `log` application:
[source,bash,options="nowrap"]
----
dataflow:> app info --name log --type sink
Information about sink application 'log':
Version: '3.2.1':
Default application version: 'true':
Resource URI: maven://org.springframework.cloud.stream.app:log-sink-rabbit:3.2.1
╔══════════════════════════════╤══════════════════════════════╤══════════════════════════════╤══════════════════════════════╗
║ Option Name │ Description │ Default │ Type ║
╠══════════════════════════════╪══════════════════════════════╪══════════════════════════════╪══════════════════════════════╣
Expand Down

0 comments on commit e8b79bb

Please sign in to comment.