Skip to content

Commit

Permalink
Update docs for the release 0.0.1-20240627.1 (#53)
Browse files Browse the repository at this point in the history
Co-authored-by: luisquix <luisquix@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and luisquix authored Jun 27, 2024
1 parent 2387b34 commit d2cf499
Show file tree
Hide file tree
Showing 14 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/Reference/applications/variables/export.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ quix applications variables export [options]

**Options:**

- `--workspace-id <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
- `--workspace-id <workspace-id>` : The environment to use if your SDK broker configuration is set to Quix Cloud
- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--reset` : Removes all the values of existing env variables and adds them from the app.yaml file [default: False]
Expand Down
2 changes: 1 addition & 1 deletion docs/Reference/cloud/users/tokens/create.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ quix cloud users tokens create <name> [options]
**Options:**

- `-o, --output <json|table>` : Output type of the retrieved data
- `--expires-at <expires-at>` : Define when the token will expire. Supports ISO 8601 dates: 'YYYY-MM-DD HH:MM:SS.sss'. All times UTC. [default: 2025-06-26]
- `--expires-at <expires-at>` : Define when the token will expire. Supports ISO 8601 dates: 'YYYY-MM-DD HH:MM:SS.sss'. All times UTC. [default: 2025-06-27]
- `-p, --permission-assignments <permission-assignments> (REQUIRED)` : Array of permission assignments in the format "[{Scope, Permission, Permission, ..}, {Scope, Permission, Permission, ..}, ...]"

6 changes: 3 additions & 3 deletions docs/Reference/contexts/broker/cloud.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Set the Sdk broker configuration to point to a 'Quix Cloud' broker
Set the SDK broker configuration to point to a 'Quix Cloud' broker

**Aliases:** `cloud`, `disable`

Expand All @@ -14,8 +14,8 @@ quix contexts broker cloud [options]

**Options:**

- `--workspace-id <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
- `--workspace-id <workspace-id>` : The environment to use if your SDK broker configuration is set to Quix Cloud
- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration
- `--update` : Update '.env' files of all the applications with the current SDK broker configuration

8 changes: 4 additions & 4 deletions docs/Reference/contexts/broker/index.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
Manage the SDK broker configuration that is injected to QuixStreams while developing locally

**Aliases:** `broker`

Expand All @@ -14,7 +14,7 @@ quix contexts broker [command] [options]

**Commands:**

- [cloud](cloud.md) : Set the Sdk broker configuration to point to a 'Quix Cloud' broker
- [local](local.md) : Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker)
- [set](set.md) : Set a local broker address for the Sdk broker configuration
- [cloud](cloud.md) : Set the SDK broker configuration to point to a 'Quix Cloud' broker
- [local](local.md) : Set the SDK broker configuration to point to a 'Local' broker (default: pipeline broker)
- [set](set.md) : Set a local broker address for the SDK broker configuration

4 changes: 2 additions & 2 deletions docs/Reference/contexts/broker/local.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker)
Set the SDK broker configuration to point to a 'Local' broker (default: pipeline broker)

**Aliases:** `local`, `enable`

Expand All @@ -16,5 +16,5 @@ quix contexts broker local [options]

- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration
- `--update` : Update '.env' files of all the applications with the current SDK broker configuration

10 changes: 5 additions & 5 deletions docs/Reference/contexts/broker/set.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Set a local broker address for the Sdk broker configuration
Set a local broker address for the SDK broker configuration

**Aliases:** `set`

Expand All @@ -14,13 +14,13 @@ quix contexts broker set [<address>] [options]

**Arguments:**

- `<address>` : The broker address for the Sdk broker configuration (ie: localhost:19092)
- `<address>` : The broker address for the SDK broker configuration (ie: localhost:19092)

**Options:**

- `--enable` : Enables Local broker as Sdk broker configuration
- `--workspace-id <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
- `--enable` : Enables Local broker as SDK broker configuration
- `--workspace-id <workspace-id>` : The environment to use if your SDK broker configuration is set to Quix Cloud
- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration []
- `--update` : Update '.env' files of all the applications with the current SDK broker configuration []

6 changes: 3 additions & 3 deletions docs/Reference/contexts/create.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ quix contexts create [<name>] [options]
**Options:**

- `-e, --endpoint <endpoint>` : Portal endpoint
- `-b, --sdk-broker-address <sdk-broker-address>` : Sdk broker configuration address
- `-c, --use-quix-cloud-broker` : Set the Sdk broker configuration to the one in your Quix Cloud environment
- `-l, --use-local-broker` : Set the Sdk broker configuration to one accessible from your local machine
- `-b, --sdk-broker-address <sdk-broker-address>` : SDK broker configuration address
- `-c, --use-quix-cloud-broker` : Set the SDK broker configuration to the one in your Quix Cloud environment
- `-l, --use-local-broker` : Set the SDK broker configuration to one accessible from your local machine

2 changes: 1 addition & 1 deletion docs/Reference/contexts/index.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ quix contexts [command] [options]

**Commands:**

- [broker](broker/index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
- [broker](broker/index.md) : Manage the SDK broker configuration that is injected to QuixStreams while developing locally
- [create](create.md) : Add a new context to the CLI
- [current](current.md) : Gets information about the current context
- [delete](delete.md) : Remove a context from the CLI
Expand Down
6 changes: 3 additions & 3 deletions docs/Reference/sdk/broker/cloud.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Set the Sdk broker configuration to point to a 'Quix Cloud' broker
Set the SDK broker configuration to point to a 'Quix Cloud' broker

**Aliases:** `cloud`, `disable`

Expand All @@ -14,8 +14,8 @@ quix sdk broker cloud [options]

**Options:**

- `--workspace-id <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
- `--workspace-id <workspace-id>` : The environment to use if your SDK broker configuration is set to Quix Cloud
- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration
- `--update` : Update '.env' files of all the applications with the current SDK broker configuration

10 changes: 5 additions & 5 deletions docs/Reference/sdk/broker/index.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
Manage the SDK broker configuration that is injected to QuixStreams while developing locally

**Aliases:** `broker`

Expand All @@ -14,8 +14,8 @@ quix sdk broker [command] [options]

**Commands:**

- [cloud](cloud.md) : Set the Sdk broker configuration to point to a 'Quix Cloud' broker
- [local](local.md) : Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker)
- [set](set.md) : Set a local broker address for the Sdk broker configuration
- [update](update.md) : Update '.env' files of all the applications with the current Sdk broker configuration
- [cloud](cloud.md) : Set the SDK broker configuration to point to a 'Quix Cloud' broker
- [local](local.md) : Set the SDK broker configuration to point to a 'Local' broker (default: pipeline broker)
- [set](set.md) : Set a local broker address for the SDK broker configuration
- [update](update.md) : Update '.env' files of all the applications with the current SDK broker configuration

4 changes: 2 additions & 2 deletions docs/Reference/sdk/broker/local.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Set the Sdk broker configuration to point to a 'Local' broker (default: pipeline broker)
Set the SDK broker configuration to point to a 'Local' broker (default: pipeline broker)

**Aliases:** `local`, `enable`

Expand All @@ -16,5 +16,5 @@ quix sdk broker local [options]

- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration
- `--update` : Update '.env' files of all the applications with the current SDK broker configuration

10 changes: 5 additions & 5 deletions docs/Reference/sdk/broker/set.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Set a local broker address for the Sdk broker configuration
Set a local broker address for the SDK broker configuration

**Aliases:** `set`

Expand All @@ -14,13 +14,13 @@ quix sdk broker set [<address>] [options]

**Arguments:**

- `<address>` : The broker address for the Sdk broker configuration (ie: localhost:19092)
- `<address>` : The broker address for the SDK broker configuration (ie: localhost:19092)

**Options:**

- `--enable` : Enables Local broker as Sdk broker configuration
- `--workspace-id <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
- `--enable` : Enables Local broker as SDK broker configuration
- `--workspace-id <workspace-id>` : The environment to use if your SDK broker configuration is set to Quix Cloud
- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)
- `--update` : Update '.env' files of all the applications with the current Sdk broker configuration []
- `--update` : Update '.env' files of all the applications with the current SDK broker configuration []

4 changes: 2 additions & 2 deletions docs/Reference/sdk/broker/update.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Update '.env' files of all the applications with the current Sdk broker configuration
Update '.env' files of all the applications with the current SDK broker configuration

**Aliases:** `update`

Expand All @@ -14,7 +14,7 @@ quix sdk broker update [options]

**Options:**

- `--workspace-id <workspace-id>` : The environment to use if your Sdk broker configuration is set to Quix Cloud
- `--workspace-id <workspace-id>` : The environment to use if your SDK broker configuration is set to Quix Cloud
- `--env-file-name <env-file-name>` : Set the name of the environment file [default: .env]
- `--directory <directory>` : Base directory (defaults to current directory)

4 changes: 2 additions & 2 deletions docs/Reference/sdk/index.gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview

Set the Sdk configuration that is injected to QuixStreams while developing locally
Set the SDK configuration that is injected to QuixStreams while developing locally

**Aliases:** `sdk`, `settings`, `config`

Expand All @@ -14,5 +14,5 @@ quix sdk [command] [options]

**Commands:**

- [broker](broker/index.md) : Manage the Sdk broker configuration that is injected to QuixStreams while developing locally
- [broker](broker/index.md) : Manage the SDK broker configuration that is injected to QuixStreams while developing locally

0 comments on commit d2cf499

Please sign in to comment.