Skip to content

Commit ce388b9

Browse files
#10 Update documention
1 parent c2a7f6f commit ce388b9

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

docs/reference/tasks/01-FileFetchTask.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,29 @@ Options
3838
Examples
3939
--------
4040

41+
* Simple fetch task configuration
42+
- See config/packages/flysystem.yaml to see configured flysystems/storages.
43+
- copy all .csv files from 'storage.source' to 'storage.destination'
44+
- remove .csv from 'storage.source' after copy
45+
- output will be filename of copied files
4146
```yaml
4247
# Task configuration level
4348
code:
4449
service: '@CleverAge\FlysystemProcessBundle\Task\FileFetchTask'
45-
description: >
46-
Download all .csv files from storage.source to storage.destination.
47-
See config/packages/flysystem.yaml to see configured flysystem/storages.
4850
options:
4951
source_filesystem: 'storage.source'
5052
destination_filesystem: 'storage.destination'
5153
file_pattern: '/.csv$/'
5254
remove_source: true
5355
```
5456
57+
* Simple fetch process configuration to cipy a specific file from --input option via <br> ```bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv```
58+
- See config/packages/flysystem.yaml to see configured flysystems/storages.
59+
- copy input file from 'storage.source' to 'storage.destination'
60+
- remove .csv from 'storage.source' after copy
61+
- output will be filename of copied file
5562
```yaml
5663
# Full process configuration to use input as filename with the following call
57-
# bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv
5864
my_custom_process:
5965
entry_point: copy_from_input
6066
tasks:

docs/reference/tasks/02-ListContentTask.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,14 @@ Options
2828

2929
Examples
3030
--------
31-
31+
* Simple list task configuration from a filesystem
32+
- see config/packages/flysystem.yaml to see configured flysystems/storages.
33+
- list all .csv files from 'storage.source'
34+
- output will be League\Flysystem\StorageAttributes representation of copied files
3235
```yaml
3336
# Task configuration level
3437
code:
3538
service: '@CleverAge\FlysystemProcessBundle\Task\ListContentTask'
36-
description: >
37-
List .csv files from storage.source.
38-
See config/packages/flysystem.yaml to see configured flysystem/storages.
39-
outputs: get_file_path
4039
options:
4140
filesystem: 'storage.source'
4241
file_pattern: '/.csv$/'

docs/reference/tasks/03-RemoveFileTask.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ Options
3131

3232
Examples
3333
--------
34-
34+
* Simple process to remove a file on 'storage.source' via <br>```bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv```
35+
- see config/packages/flysystem.yaml to see configured flysystems/storages.
36+
- remove file with name passed as input
3537
```yaml
36-
# bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv
38+
#
3739
my_custom_process:
3840
entry_point: remove_from_input
3941
tasks:

0 commit comments

Comments
 (0)