Adds documentation for deployments (#6969)

* Adds documentation for deployments

* Add docs for fusion configuration

Author: PascalSenn

website/src/docs/bananacakepop/v2/apis/deployments.md

@@ -0,0 +1,18 @@
+---
+title: "Deployment"
+---
+
+![Deployment](./images/deployments-0.png)
+
+Deploying a service typically involves publishing a client, schema, or fusion configuration to a stage. This process is an integral part of your service's deployment, where artifacts from your CI/CD pipeline are pushed to the platform and then published to a designated stage prior to the actual deployment of your service.
+
+Whenever you initiate a deployment of a client, schema, or fusion configuration through Barista, it logs an entry in the "Deployments" tab. This tab provides a chronological overview of all deployments executed on the stage, offering visibility into the deployment history and status.
+
+## Setup Approvals
+In development environments, it's not uncommon for GraphQL changes to introduce breaking changes. To mitigate the risk of manually pushing such changes to a stage, Barista offers the `--wait-for-approval` flag. This option can be utilized when publishing a schema, client, or fusion configuration and serves as a time saver by allowing you to review and approve deployments directly from the "Deployments" tab.
+
+Deployments flagged with `--wait-for-approval` are held in a pending state, awaiting approval. They remain in this state until explicitly approved or automatically timed out after 10 minutes. This mechanism allows for a controlled deployment process, where potentially breaking changes can be reviewed and either approved or rejected directly from the "Deployments" tab.
+
+![Deployment](./images/deployments-1.png)
+
+

website/src/docs/bananacakepop/v2/apis/images/deployments-0.png

@@ -25,6 +25,8 @@ barista client publish  \
 
 - `--api-key <api-key>`: Specifies the API key used for authentication. It doesn't have to be provided when you are logged in. Otherwise, it's the secret that `barista api-key create` returns. You can set it from the environment variable `BARISTA_API_KEY`.
 
+- `--wait-for-approval`: Waits for a user to approve the schema change in the app in case of a breaking change.
+
 # Unpublish a Client
 
 The `barista client unpublish` command is used to unpublish a client version from a stage.

website/src/docs/bananacakepop/v2/apis/images/deployments-1.png

@@ -0,0 +1,131 @@
+---
+title: Fusion Configuration Management
+---
+
+# Fusion Configuration Publish
+The `barista fusion-configuration publish` command provides a set of subcommands that allow you to begin, start, validate, cancel, and commit a fusion configuration publish, facilitating the management and deployment of fusion configurations.
+
+## Begin a Configuration Publish
+
+The `barista fusion-configuration publish begin` command requests a deployment slot to begin the publish process of a fusion configuration.
+
+```shell
+barista fusion-configuration publish begin \
+  --tag <tag> \
+  --stage <stage> \
+  --api-id <api-id> \
+  [--subgraph-id <subgraph-id>] \
+  [--subgraph-name <subgraph-name>] \
+  [--wait-for-approval] \
+  [--api-key <api-key>]
+```
+
+**Options:**
+
+- `--tag <tag>` **(required)**: Specifies the tag of the schema version to deploy. You can set it from the environment variable `BARISTA_TAG`.
+
+- `--stage <stage>` **(required)**: Specifies the name of the stage. You can set it from the environment variable `BARISTA_STAGE`.
+
+- `--api-id <api-id>` **(required)**: Specifies the ID of the API. You can set it from the environment variable `BARISTA_API_ID`.
+
+- `--subgraph-id <subgraph-id>`: Specifies the ID of the subgraph. You can set it from the environment variable `BARISTA_SUBGRAPH_ID`.
+
+- `--subgraph-name <subgraph-name>`: Specifies the name of the subgraph. You can set it from the environment variable `BARISTA_SUBGRAPH_NAME`.
+
+- `--wait-for-approval`: Waits for a user to approve the schema change in the app in case of a breaking change.
+
+- `--api-key <api-key>`: Specifies the API key used for authentication. You can set it from the environment variable `BARISTA_API_KEY`.
+
+## Start a Fusion Configuration Publish
+
+The `barista fusion-configuration publish start` command initiates the publish process of a fusion configuration.
+This command has to be executed just after the completion of the `begin` command to confirm the deployment slot.
+
+```shell
+barista fusion-configuration publish start \
+  --request-id <request-id> \
+  [--api-key <api-key>]
+```
+
+**Options:**
+
+- `--request-id <request-id>`: Specifies the ID of the request. You do not have to provide this when you executed the `begin` command in the same session.
+
+- `--api-key <api-key>`: Specifies the API key used for authentication. You can set it from the environment variable `BARISTA_API_KEY`.
+
+## Validate a Fusion Configuration
+
+The `barista fusion-configuration publish validate` command validates a fusion configuration against the schema and clients.
+This step is optional and can be used to ensure that the configuration is correct before committing the publish.
+
+```shell
+barista fusion-configuration publish validate \
+  --request-id <request-id> \
+  --configuration <configuration> \
+  [--api-key <api-key>]
+```
+
+**Options:**
+
+- `--request-id <request-id>`: Specifies the ID of the request. You do not have to provide this when you executed the `begin` command in the same session.
+
+- `--configuration <configuration>` **(required)**: Specifies the path to the fusion configuration file. You can set it from the environment variable `BARISTA_FUSION_CONFIG_FILE`.
+
+- `--api-key <api-key>`: Specifies the API key used for authentication. You can set it from the environment variable `BARISTA_API_KEY`.
+
+## Commit a Fusion Configuration Publish
+
+The `barista fusion-configuration publish commit` command commits the publish process of a fusion configuration.
+
+```shell
+barista fusion-configuration publish commit \
+  --request-id <request-id> \
+  --configuration <configuration> \
+  [--api-key <api-key>]
+```
+
+**Options:**
+
+- `--request-id <request-id>`: Specifies the ID of the request. You do not have to provide this when you executed the `begin` command in the same session.
+
+- `--configuration <configuration>` **(required)**: Specifies the path to the fusion configuration file. You can set it from the environment variable `BARISTA_FUSION_CONFIG_FILE`.
+
+- `--api-key <api-key>`: Specifies the API key used for authentication. You can set it from the environment variable `BARISTA_API_KEY`.
+
+## Cancel a Fusion Configuration Publish
+
+The `barista fusion-configuration publish cancel` command cancels the publish process of a fusion configuration.
+
+```shell
+barista fusion-configuration publish cancel \
+  --request-id <request-id> \
+  [--api-key <api-key>]
+```
+
+**Options:**
+
+- `--request-id <request-id>`: Specifies the ID of the request. You do not have to provide this when you executed the `begin` command in the same session.
+
+- `--api-key <api-key>`: Specifies the API key used for authentication. You can set it from the environment variable `BARISTA_API_KEY`.
+
+# Download the Most Recent Gateway Configuration
+
+The `barista fusion-configuration download` command is used to download the most recent gateway configuration.
+
+```shell
+barista fusion-configuration download \
+  --stage <stage> \
+  --api-id <api-id> \
+  [--output-file <output-file>] \
+  [--api-key <api-key>]
+```
+
+**Options:**
+
+- `--stage <stage>` **(required)**: Specifies the name of the stage. You can set it from the environment variable `BARISTA_STAGE`.
+
+- `--api-id <api-id>` **(required)**: Specifies the ID of the API. You can set it from the environment variable `BARISTA_API_ID`.
+
+- `--output-file <output-file>`: Specifies the path and name of the output file where the downloaded configuration will be saved. You can set it from the environment variable `BARISTA_OUTPUT_FILE`.
+
+- `--api-key <api-key>`: Specifies the API key used for authentication. It's required if you are not logged in. You can set it from the environment variable `BARISTA_API_KEY`.

website/src/docs/barista/v1/commands/client.md

@@ -22,6 +22,7 @@ barista schema publish \
 - `--api-id <api-id>` **(required)**: Specifies the ID of the API to which you are uploading the schema. This ID can be retrieved with the `barista api list` command. You can set it from the environment variable `BARISTA_API_ID`.
 - `--force`: Forces the operation to succeed even if there are errors.
 - `--api-key <api-key>`: Specifies the API key used for authentication. It doesn't have to be provided when you are logged in. Otherwise, it's the secret that `barista api-key create` returns. You can set it from the environment variable `BARISTA_API_KEY`.
+- `--wait-for-approval`: Waits for a user to approve the schema change in the app in case of a breaking change.
 
 # Validate a Schema
 

website/src/docs/barista/v1/commands/fusion-configuration.md

@@ -46,6 +46,7 @@
             "items": [
               { "path": "overview", "title": "Overview" },
               { "path": "stages", "title": "Stages" },
+              { "path": "deployments", "title": "Deployments" },
               { "path": "fusion", "title": "Fusion" },
               {
                 "path": "schema-registry",
@@ -1491,6 +1492,10 @@
               { "path": "logout", "title": "logout" },
               { "path": "schema", "title": "schema" },
               { "path": "stage", "title": "stage" },
+              {
+                "path": "fusion-configuration",
+                "title": "fusion-configuration"
+              },
               { "path": "workspace", "title": "workspace" }
             ]
           }