#92 - Documentation: use the storage format of league/flysystem-bundle 3.5

CHANGELOG.md

@@ -1,6 +1,9 @@
 Latest
 ------
 
+### Changes
+* [#92](https://github.com/cleverage/flysystem-process-bundle/issues/92) Documentation: the storages are configured with the format of league/flysystem-bundle 3.5 and later (the adapter being the key of its options), the `adapter` / `options` format being deprecated since flysystem-bundle 3.5; the former format is mentioned for an earlier version.
+
 v3.4
 ------
 

docs/cookbooks/sftp_import.md

@@ -15,21 +15,18 @@ parameters:
 flysystem:
     storages:
         local.storage:
-            adapter: 'local'
-            options:
+            local:
                 directory: '%local.storage.dir%'
 
         remote.storage.incoming:
-            adapter: 'sftp'
-            options:
+            sftp:
                 host: '%env(string:SFTP_HOST)%'
                 username: '%env(string:SFTP_USERNAME)%'
                 password: '%env(string:SFTP_PASSWORD)%'
                 root: '%env(string:SFTP_ROOT)%/incoming'
 
         remote.storage.archive:
-            adapter: 'sftp'
-            options:
+            sftp:
                 host: '%env(string:SFTP_HOST)%'
                 username: '%env(string:SFTP_USERNAME)%'
                 password: '%env(string:SFTP_PASSWORD)%'

docs/index.md

@@ -45,20 +45,21 @@ The tasks of this bundle work with the Flysystem **storages** configured in `con
 flysystem:
     storages:
         local.storage: # Name of the storage, used in the task options
-            adapter: 'local'
-            options:
+            local:
                 directory: '%kernel.project_dir%/var/storage/local'
 
         remote.storage:
-            adapter: 'sftp'
-            options:
+            sftp:
                 host: '%env(string:SFTP_HOST)%'
                 port: 22
                 username: '%env(string:SFTP_USERNAME)%'
                 password: '%env(string:SFTP_PASSWORD)%'
                 root: '%env(string:SFTP_ROOT)%'
 ```
 
+This is the format of league/flysystem-bundle 3.5 and later, the adapter being the key of its options. With an
+earlier version, use `adapter: 'local'` and `options:` (deprecated since flysystem-bundle 3.5).
+
 Paths used and returned by the tasks are relative to the root of the storage (`directory` or `root` option).
 Listings (`file_pattern` options, [ListContentTask](reference/tasks/list_content_task.md)) are not recursive: to work
 in a sub-directory, configure a dedicated storage whose root is this directory.

docs/troubleshooting.md

@@ -89,8 +89,7 @@ passing the service id:
 flysystem:
   storages:
     remote.storage:
-      adapter: 'sftp'
-      options:
+      sftp:
         host: '%env(string:SFTP_HOST)%'
         port: '%env(int:SFTP_PORT)%'
         username: '%env(string:SFTP_USERNAME)%'