Merge branch 'master' into feature/magento-2-logical-cursor-for-long-filter

Author: JoMessina

config.toml

@@ -216,6 +216,17 @@ hasChildren = true
   url = "connectivity/zoho"
   weight = 15
 
+[[menu.main]]
+weight = 4
+name = "Cloud"
+hasChildren = true
+
+  [[menu.main]]
+  parent = "Cloud"
+  name = "Usage"
+  url = "cloud/usage"
+  weight = 1
+
 [params]
 logo = "logo-web.svg"
 logo_white = "logo-web.svg"

content/cloud/usage/_index.en.md

@@ -0,0 +1,97 @@
+---
+title: "Usage"
+date: 2024-01-12T14:52:40+01:00
+draft: true
+---
+
+Gyroscops also allows you to have your satellites stored in the cloud.
+
+Thanks to the cloud executable provided by the package `php-etl/satellite`,
+you can manage your satellites quickly and easily thanks to command lines.
+
+## Requirements
+
+Before you start, make sure you have installed the utility in your project.
+
+If you haven't already done so, simply run this command:
+
+```shell
+composer require php-etl/satellite:'*'
+```
+
+## Log into the API
+
+The `login` command is used to establish a connection with the Gyroscops API, allowing access to the various functionalities.
+Before executing this command, make sure you have the necessary identification information to hand.
+
+```shell
+bin/cloud login
+```
+
+> The service may ask you to select your organization and your workspace.
+
+### Options
+- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
+- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
+- `--ssl`|`--no-ssl`: Enable or disable SSL
+- `--help`:  Display help for the given command
+
+See the following sections of this documentation for details of the various commands.
+
+## Create your satellite
+
+The `create` command is used to create a satellite associated with your account.
+
+```shell
+php bin/cloud create <path/to/satellite.yaml>
+```
+
+### Options
+- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
+- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
+- `--ssl`|`--no-ssl`: Enable or disable SSL
+- `--help`:  Display help for the given command
+
+Once you have created your satellite, you can access its configuration from the interface by following these steps:
+
+- Enter the following URL in the address bar: https://app.gyroscops.com (or https://beta.gyroscops.com)
+- Log in with your credentials
+
+## Update your satellite
+
+The `update` command is used to update a given satellite.
+
+```shell
+php bin/cloud update <path/to/satellite.yaml>
+```
+
+### Options
+- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
+- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
+- `--ssl`|`--no-ssl`: Enable or disable SSL
+- `--help`:  Display help for the given command
+
+## Remove your satellite
+
+The `remove` command is used to remove a given satellite.
+
+```shell
+php bin/cloud remove <path/to/satellite.yaml>
+```
+
+### Options
+- `-u`, `--url`: Base URL of the cloud instance [default: "https://app.gyroscops.com"]
+- `--beta`: Shortcut to set the cloud instance to https://beta.gyroscops.com
+- `--ssl`|`--no-ssl`: Enable or disable SSL
+- `--help`:  Display help for the given command
+
+## Other commands
+
+In addition to the main commands we have already explored, this command line utility offers a number of additional features. 
+These commands can be useful in a variety of situations. 
+
+For a list of these commands, use the following command:
+
+```shell
+bin/cloud list
+```

content/connectivity/akeneo/_index.en.md

@@ -8,15 +8,15 @@ description: "Connect your Akeneo PIM through pipelines"
 weight: 1
 ---
 
-The packages listed below aims at the integration of [Akeneo PIM](https://www.akeneo.com) into the [ETL Pipeline](../../core-concept/pipeline) 
+The packages listed below aims at the integration of [Akeneo PIM](https://www.akeneo.com) into the [ETL Pipeline](../../core-concept/satellite/pipeline) 
 and [Satellite](../../core-concept/satellite) stacks.
 
 The tools built for Akeneo is composed of ETL capacities and data processing functions to be used in
 [Fast Map](../fast-map).
 
 ### The Akeneo plugin for ETL Pipeline
 
-This plugin will enable Akeneo connectivity to the [ETL Pipeline](../../core-concept/pipeline), in order to
+This plugin will enable Akeneo connectivity to the [ETL Pipeline](../../core-concept/satellite/pipeline), in order to
 read and write from and to Akeneo PIM. This integration is compatible with both
 [Akeneo Enterprise Edition client](https://github.com/akeneo/api-php-client-ee)
 and the [Akeneo Community Edition client](https://github.com/akeneo/api-php-client).

content/connectivity/akeneo/plugin.en.md

@@ -33,7 +33,7 @@ and the [Akeneo Community Edition client](https://github.com/akeneo/api-php-clie
 ## Installation
 
 ```shell
-composer require php-etl/akeneo-plugin
+composer require php-etl/akeneo-plugin:'*'
 ```
 
 ## Usage

content/connectivity/csv/_index.en.md

@@ -29,7 +29,7 @@ stack.
 ## Installation
 
 ```shell
-composer require php-etl/csv-plugin
+composer require php-etl/csv-plugin:'*'
 ```
 
 ## Usage

content/connectivity/custom/_index.en.md

@@ -8,12 +8,16 @@ description: "Read transform and write files in any format"
 weight: 3
 ---
 
-- [What is it ?](#what-is-it-)
+- [What is it ?](#definition)
 - [Installation](#installation)
 - [Usage](#usage)
   - [Building an extractor](#building-an-extractor)
   - [Building a transformer](#building-a-transformer)
   - [Building a loader](#building-a-loader)
+- [Usage examples](#usage-examples)
+  - [Example of an extractor](#example-of-an-extractor)
+  - [Example of a transformer](#example-of-a-transformer)
+  - [Example of a loader](#example-of-a-loader)
 ---
 
 ## Definition
@@ -29,47 +33,58 @@ This plugin is already integrated into the Satellite package, so you can’t req
 
 Unlike other plugins, the configuration is the same whether it is an extractor, a transformer or a loader.
 
-First you need to [determine your services](../../feature/services) in your pipeline or workflow and then use the `use` 
-option which allows you to define which service to use.
-
 ### Building an extractor
 
+In the example given, we explain how to configure a custom extractor with the `Bar` class located in the `App\Class` namespace.
+
+Here's a more detailed explanation:
+
 ```yaml
 custom:
   extractor:
-    use: 'App\Class\Bar'
+    use: 'App\Class\Bar' # This line specifies the extractor class you want to use.
     services:
-      App\Class\Bar:
-        arguments:
-            - '@foo'
-        tags:
-            - { example }
+      App\Class\Bar: ~ # Here, we declare the service associated with the Bar class with the syntax App\Class\Bar: ~. This simply indicates that we want to use the default parameters for this service.
 ```
 
+For more details about service configurations, please visit the [declaring-services](../../feature/services) documentation.
+
 ### Building a transformer
 
+In the example given, we explain how to configure a custom extractor with the `Bar` class located in the `App\Class` namespace.
+
+Here's a more detailed explanation:
+
 ```yaml
 custom:
   transformer:
-    use: 'App\Class\Bar'
+    use: 'App\Class\Bar' # This line specifies the extractor class you want to use.
     services:
-      App\Class\Bar:
-        arguments:
-            - '@foo'
-        tags:
-            - { example }
+      App\Class\Bar: # Here, we declare the service associated with the Bar class.
+        factory: # This section indicates that the service must be created by calling the extract method of the App\Class\Bar class.
+          class: App\Class\Bar
+          method: extract
+        arguments: # The arguments to be passed to the extract method. In this example, the @foo symbol indicates that the foo service should be injected as an argument. Make sure that the foo service is configured correctly elsewhere in your pipeline.
+          - '@foo'
+      foo: ~
 ```
 
+For more details about service configurations, please visit the [declaring-services](../../feature/services) documentation.
+
 ### Building a loader
 
+In the example given, we explain how to configure a custom extractor with the `Bar` class located in the `App\Class` namespace.
+
+Here's a more detailed explanation:
+
 ```yaml
 custom:
   loader:
-    use: 'App\Class\Bar'
+    use: 'App\Class\Bar' # This line specifies the extractor class you want to use.
     services:
-      App\Class\Bar:
-        arguments:
-            - '@foo'
-        tags:
-            - { example }
+      App\Class\Bar: # Here, we declare the service associated with the Bar class.
+        calls: # This section indicates that specific method calls must be made to the service instance.
+          - withUsername: [ 'admin' ] # This means that a method call named withUsername must be made to the instance of the Bar class, with the username "admin" passed as an argument.
 ```
+
+For more details about service configurations, please visit the [declaring-services](../../feature/services) documentation.

content/connectivity/fast-map/_index.en.md

@@ -56,7 +56,7 @@ This code will then be converted into a machine code that can be used by the fas
 ## Installation
 
 ```shell
-composer require php-etl/fast-map-plugin
+composer require php-etl/fast-map-plugin:'*'
 ```
 
 ## Usage
@@ -221,4 +221,4 @@ fastmap:
       append: true
       object:
         # ...
-```
+```

content/connectivity/json/_index.en.md

@@ -32,7 +32,7 @@ stack.
 In a Satellite project, add the JSON plugin this way:
 
 ```shell
-composer require php-etl/json-plugin
+composer require php-etl/json-plugin:'*'
 ```
 
 ## Usage

content/connectivity/magento-2/_index.en.md

@@ -23,7 +23,7 @@ This package includes classes to extract data from Magento, using a [custom conn
 ## Installation
 
 ```shell
-composer require "php-etl/magento2-flow:*"
+composer require php-etl/magento2-flow:'*'
 ```
 
 This package includes classes and code that you will be able to use in your custom connector.

content/connectivity/prestashop/_index.en.md

@@ -28,7 +28,7 @@ Currently, the following resources are supported by the plugin: `categories`, `c
 ## Installation
 
 ```shell
-composer require "php-etl/prestashop-plugin:*"
+composer require php-etl/prestashop-plugin:'*'
 ```
 
 ## Usage