Skip to content
This repository was archived by the owner on May 14, 2025. It is now read-only.

Commit e8b79bb

Browse files
jvalkealjvalkeal
committed
Polish shell related docs
- Polishing some copied outputs as new spring-shell gives different output on some cases. - Relates #4946
1 parent f9d5806 commit e8b79bb

File tree

3 files changed

+61
-46
lines changed

3 files changed

+61
-46
lines changed

‎spring-cloud-dataflow-docs/src/main/asciidoc/configuration.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ Do not forget to target the Data Flow Server with the following command:
319319
====
320320
[source,bash]
321321
----
322-
dataflow:> dataflow config server https://localhost:8443/
322+
dataflow:> dataflow config server --uri https://localhost:8443/
323323
----
324324
====
325325

‎spring-cloud-dataflow-docs/src/main/asciidoc/shell.adoc‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,14 @@ The following listing shows the output of the `help` command:
5858
====
5959
[source,bash]
6060
----
61-
! - Allows execution of operating system (OS) commands
62-
clear - Clears the console
63-
cls - Clears the console
64-
date - Displays the local date and time
65-
exit - Exits the shell
66-
http get - Make GET request to http endpoint
67-
http post - POST data to http endpoint
68-
quit - Exits the shell
69-
system properties - Shows the shells properties {JB - restore the apostrophe}
70-
version - Displays shell version
61+
Built-In Commands
62+
help: Display help about available commands
63+
stacktrace: Display the full stacktrace of the last error.
64+
clear: Clear the shell screen.
65+
quit, exit: Exit the shell.
66+
history: Display or save the history of previously run commands
67+
version: Show version info
68+
script: Read and execute commands from a file.
7169
----
7270
====
7371

@@ -77,26 +75,28 @@ Adding the name of the command to `help` shows additional information on how to
7775
[source,bash]
7876
----
7977
dataflow:>help stream create
80-
Keyword: stream create
81-
Description: Create a new stream definition
82-
Keyword: ** default **
83-
Keyword: name
84-
Help: the name to give to the stream
85-
Mandatory: true
86-
Default if specified: '__NULL__'
87-
Default if unspecified: '__NULL__'
78+
NAME
79+
stream create - Create a new stream definition
8880
89-
Keyword: definition
90-
Help: a stream definition, using the DSL (e.g. "http --port=9000 | hdfs")
91-
Mandatory: true
92-
Default if specified: '__NULL__'
93-
Default if unspecified: '__NULL__'
81+
SYNOPSIS
82+
stream create [--name String] [--definition String] --description String --deploy boolean
9483
95-
Keyword: deploy
96-
Help: whether to deploy the stream immediately
97-
Mandatory: false
98-
Default if specified: 'true'
99-
Default if unspecified: 'false'
84+
OPTIONS
85+
--name String
86+
the name to give to the stream
87+
[Mandatory]
88+
89+
--definition String
90+
a stream definition, using the DSL (e.g. "http --port=9000 | hdfs")
91+
[Mandatory]
92+
93+
--description String
94+
a short description about the stream
95+
[Optional]
96+
97+
--deploy boolean
98+
whether to deploy the stream immediately
99+
[Optional, default = false]
100100
----
101101
====
102102

@@ -109,7 +109,7 @@ You can complete the shell command options in the shell by pressing the `TAB` ke
109109
[source,bash]
110110
----
111111
dataflow:>stream create --
112-
stream create --definition stream create --name
112+
--definition --deploy --description --name
113113
----
114114
====
115115

‎spring-cloud-dataflow-docs/src/main/asciidoc/streams.adoc‎

Lines changed: 31 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -451,11 +451,11 @@ The `stream info` command shows useful information about the stream, as shown (w
451451
[source,bash]
452452
----
453453
dataflow:>stream info ticktock
454-
╔═══════════╤═════════════════╤══════════╗
455-
║Stream Name│Stream Definition│ Status ║
456-
╠═══════════╪═════════════════╪══════════╣
457-
║ticktock │time | log │undeployed║
458-
╚═══════════╧═════════════════╧══════════╝
454+
╔═══════════╤═════════════════╤═══════════╤══════════╗
455+
║Stream Name│Stream Definition│Description│ Status ║
456+
╠═══════════╪═════════════════╪═══════════╪══════════╣
457+
║ticktock │time | log │ │undeployed║
458+
╚═══════════╧═════════════════╧═══════════╧══════════╝
459459
----
460460
====
461461

@@ -483,20 +483,31 @@ The following listing shows the exposed properties for the `time` application:
483483
[source,bash,options="nowrap"]
484484
----
485485
dataflow:> app info --name time --type source
486+
Information about source application 'time':
487+
Version: '3.2.1':
488+
Default application version: 'true':
489+
Resource URI: maven://org.springframework.cloud.stream.app:time-source-rabbit:3.2.1
486490
╔══════════════════════════════╤══════════════════════════════╤══════════════════════════════╤══════════════════════════════╗
487491
║ Option Name │ Description │ Default │ Type ║
488492
╠══════════════════════════════╪══════════════════════════════╪══════════════════════════════╪══════════════════════════════╣
489-
║trigger.time-unit │The TimeUnit to apply to delay│<none> │java.util.concurrent.TimeUnit ║
490-
║ │values. │ │ ║
491-
║trigger.fixed-delay │Fixed delay for periodic │1 │java.lang.Integer ║
492-
║ │triggers. │ │ ║
493-
║trigger.cron │Cron expression value for the │<none> │java.lang.String ║
494-
║ │Cron Trigger. │ │ ║
495-
║trigger.initial-delay │Initial delay for periodic │0 │java.lang.Integer ║
496-
║ │triggers. │ │ ║
497-
║trigger.max-messages │Maximum messages per poll, -1 │1 │java.lang.Long ║
498-
║ │means infinity. │ │ ║
499-
║trigger.date-format │Format for the date value. │<none> │java.lang.String ║
493+
║spring.integration.poller.max-│Maximum number of messages to │<none> │java.lang.Integer ║
494+
║messages-per-poll │poll per polling cycle. │ │ ║
495+
║spring.integration.poller.fixe│Polling rate period. Mutually │<none> │java.time.Duration ║
496+
║d-rate │exclusive with 'fixedDelay' │ │ ║
497+
║ │and 'cron'. │ │ ║
498+
║spring.integration.poller.fixe│Polling delay period. Mutually│<none> │java.time.Duration ║
499+
║d-delay │exclusive with 'cron' and │ │ ║
500+
║ │'fixedRate'. │ │ ║
501+
║spring.integration.poller.rece│How long to wait for messages │1s │java.time.Duration ║
502+
║ive-timeout │on poll. │ │ ║
503+
║spring.integration.poller.cron│Cron expression for polling. │<none> │java.lang.String ║
504+
║ │Mutually exclusive with │ │ ║
505+
║ │'fixedDelay' and 'fixedRate'. │ │ ║
506+
║spring.integration.poller.init│Polling initial delay. Applied│<none> │java.time.Duration ║
507+
║ial-delay │for 'fixedDelay' and │ │ ║
508+
║ │'fixedRate'; ignored for │ │ ║
509+
║ │'cron'. │ │ ║
510+
║time.date-format │Format for the date value. │MM/dd/yy HH:mm:ss │java.lang.String ║
500511
╚══════════════════════════════╧══════════════════════════════╧══════════════════════════════╧══════════════════════════════╝
501512
----
502513
====
@@ -507,6 +518,10 @@ The following listing shows the exposed properties for the `log` application:
507518
[source,bash,options="nowrap"]
508519
----
509520
dataflow:> app info --name log --type sink
521+
Information about sink application 'log':
522+
Version: '3.2.1':
523+
Default application version: 'true':
524+
Resource URI: maven://org.springframework.cloud.stream.app:log-sink-rabbit:3.2.1
510525
╔══════════════════════════════╤══════════════════════════════╤══════════════════════════════╤══════════════════════════════╗
511526
║ Option Name │ Description │ Default │ Type ║
512527
╠══════════════════════════════╪══════════════════════════════╪══════════════════════════════╪══════════════════════════════╣

0 commit comments

Comments
 (0)