Merge pull request #72 from php-etl/feature/cloud

Changed the location of the cloud doc + added more details

Author: sebprt

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/core-concept/satellite/_index.en.md

@@ -19,7 +19,6 @@ weight: 1
 - [Configuration formats](#configuration-formats)
 - Building
   - [Building locally](#build-your-satellite-locally)
-  - [Building through Gyroscops Cloud](#send-your-satellite-to-gyroscops-cloud)
 - [Migration from version 0.2 and earlier](#migration-from-version-02-and-earlier)
 - [Importing external files](#importing-external-configuration-files)
 
@@ -376,28 +375,6 @@ If you selected the [Filesystem variant](#using-the-file-system), you can now ex
 * For a Pipeline: `bin/satellite run:pipeline build/`
 * For a Workflow: `bin/satellite run:workflow build/`
 
-### Send your satellite to Gyroscops Cloud
-
-If you are using Gyroscops Cloud, you can push your satellite configuration to the service.
-
-You will need to authenticate to the service before sending your satellites.
-
-```shell
-bin/cloud login [email protected] # authenticate as [email protected] 
-```
-
-> The service may ask you to select your organization and your workspace.
-
-```shell
-# Either use the satellite.yaml file in the current working directory
-php bin/cloud create
-
-# or specify the path to the yaml file
-php bin/cloud create path/to/satellite.yaml
-```
-
-Once done, you will be able to control your satellite execution through the Gyroscops Cloud interface.
-
 ## Migration from version 0.2 and earlier
 
 If you are using a configuration for satellite prior to version 0.3, you should migrate your files ot the updated version.