Skip to content

Commit

Permalink
docs updates
Browse files Browse the repository at this point in the history
remove unnecessary attribute assignments
  • Loading branch information
janelletavares committed Jan 16, 2022
1 parent c0183ca commit 44d29a0
Show file tree
Hide file tree
Showing 73 changed files with 1,063 additions and 48 deletions.
1 change: 1 addition & 0 deletions cmd/meroxa/root/pipelines/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ func (c *Create) Execute(ctx context.Context) error {
p.Metadata = metadata
}

// If the environment specified is not the common environment.
if c.flags.Environment != "" && c.flags.Environment != string(meroxa.EnvironmentTypeCommon) {
err := builder.CheckFeatureFlag(c, &environments.Environments{})
if err != nil {
Expand Down
4 changes: 2 additions & 2 deletions cmd/meroxa/root/pipelines/create_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ func TestCreatePipelineFlags(t *testing.T) {
shorthand string
hidden bool
}{
{name: "metadata", required: false, shorthand: "m", hidden: false},
{name: "env", required: false, hidden: false},
{name: "metadata", shorthand: "m"},
{name: "env"},
}

c := builder.BuildCobraCommand(&Create{})
Expand Down
1 change: 1 addition & 0 deletions cmd/meroxa/root/resources/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ func (c *Create) Execute(ctx context.Context) error {
Metadata: nil,
}

// If the environment specified is not the common environment.
if c.flags.Environment != "" && c.flags.Environment != string(meroxa.EnvironmentTypeCommon) {
err := builder.CheckFeatureFlag(c, &environments.Environments{})
if err != nil {
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/md/meroxa.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ meroxa resources list --types
* [meroxa connect](meroxa_connect.md) - Connect two resources together
* [meroxa connectors](meroxa_connectors.md) - Manage connectors on Meroxa
* [meroxa endpoints](meroxa_endpoints.md) - Manage endpoints on Meroxa
* [meroxa environments](meroxa_environments.md) - Manage environments on Meroxa
* [meroxa login](meroxa_login.md) - Login or Sign up to the Meroxa Platform
* [meroxa logout](meroxa_logout.md) - Clears local login credentials of the Meroxa Platform
* [meroxa open](meroxa_open.md) - Open in a web browser
Expand Down
28 changes: 28 additions & 0 deletions docs/cmd/md/meroxa_environments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## meroxa environments

Manage environments on Meroxa

### Options

```
-h, --help help for environments
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa](meroxa.md) - The Meroxa CLI
* [meroxa environments create](meroxa_environments_create.md) - Create an environment
* [meroxa environments describe](meroxa_environments_describe.md) - Describe environment
* [meroxa environments list](meroxa_environments_list.md) - List environments
* [meroxa environments remove](meroxa_environments_remove.md) - Remove environment
* [meroxa environments update](meroxa_environments_update.md) - Update an environment

40 changes: 40 additions & 0 deletions docs/cmd/md/meroxa_environments_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## meroxa environments create

Create an environment

```
meroxa environments create NAME [flags]
```

### Examples

```
meroxa env create my-env --type self_hosted --provider aws --region us-east-1 --config aws_access_key_id=my_access_key --config aws_access_secret=my_access_secret
```

### Options

```
-c, --config strings environment configuration based on type and provider (e.g.: --config aws_access_key_id=my_access_key --config aws_access_secret=my_access_secret)
-h, --help help for create
--provider string environment cloud provider to use
--region string environment region
--type string environment type, when not specified
-y, --yes skip confirmation prompt
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](meroxa_environments.md) - Manage environments on Meroxa

27 changes: 27 additions & 0 deletions docs/cmd/md/meroxa_environments_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## meroxa environments describe

Describe environment

```
meroxa environments describe [NAMEorUUID] [flags]
```

### Options

```
-h, --help help for describe
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](meroxa_environments.md) - Manage environments on Meroxa

28 changes: 28 additions & 0 deletions docs/cmd/md/meroxa_environments_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## meroxa environments list

List environments

```
meroxa environments list [flags]
```

### Options

```
-h, --help help for list
--no-headers display output without headers
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](meroxa_environments.md) - Manage environments on Meroxa

28 changes: 28 additions & 0 deletions docs/cmd/md/meroxa_environments_remove.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## meroxa environments remove

Remove environment

```
meroxa environments remove NAMEorUUID [flags]
```

### Options

```
-f, --force skip confirmation
-h, --help help for remove
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](meroxa_environments.md) - Manage environments on Meroxa

38 changes: 38 additions & 0 deletions docs/cmd/md/meroxa_environments_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## meroxa environments update

Update an environment

```
meroxa environments update NAMEorUUID [flags]
```

### Examples

```
meroxa env update my-env --name new-name --config aws_access_key_id=my_access_key --config aws_access_secret=my_access_secret"
```

### Options

```
-c, --config strings updated environment configuration based on type and provider (e.g.: --config aws_access_key_id=my_access_key --config aws_access_secret=my_access_secret)
-h, --help help for update
--name string updated environment name, when specified
-y, --yes skip confirmation prompt
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](meroxa_environments.md) - Manage environments on Meroxa

1 change: 1 addition & 0 deletions docs/cmd/md/meroxa_pipelines_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ meroxa pipelines create NAME [flags]
### Options

```
--env string environment (name or UUID) where pipeline will be created
-h, --help help for create
-m, --metadata string pipeline metadata
```
Expand Down
1 change: 1 addition & 0 deletions docs/cmd/md/meroxa_resources_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ meroxa resources create slack --type url -u $WEBHOOK_URL
--ca-cert string trusted certificates for verifying resource
--client-cert string client certificate for authenticating to the resource
--client-key string client private key for authenticating to the resource
--env string environment (name or UUID) where resource will be created
-h, --help help for create
-m, --metadata string resource metadata
--password string password
Expand Down
47 changes: 47 additions & 0 deletions docs/cmd/www/meroxa-environments-create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
createdAt:
updatedAt:
title: "meroxa environments create"
slug: meroxa-environments-create
url: /cli/cmd/meroxa-environments-create/
---
## meroxa environments create

Create an environment

```
meroxa environments create NAME [flags]
```

### Examples

```
meroxa env create my-env --type self_hosted --provider aws --region us-east-1 --config aws_access_key_id=my_access_key --config aws_access_secret=my_access_secret
```

### Options

```
-c, --config strings environment configuration based on type and provider (e.g.: --config aws_access_key_id=my_access_key --config aws_access_secret=my_access_secret)
-h, --help help for create
--provider string environment cloud provider to use
--region string environment region
--type string environment type, when not specified
-y, --yes skip confirmation prompt
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](/cli/cmd/meroxa-environments/) - Manage environments on Meroxa

34 changes: 34 additions & 0 deletions docs/cmd/www/meroxa-environments-describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
createdAt:
updatedAt:
title: "meroxa environments describe"
slug: meroxa-environments-describe
url: /cli/cmd/meroxa-environments-describe/
---
## meroxa environments describe

Describe environment

```
meroxa environments describe [NAMEorUUID] [flags]
```

### Options

```
-h, --help help for describe
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](/cli/cmd/meroxa-environments/) - Manage environments on Meroxa

35 changes: 35 additions & 0 deletions docs/cmd/www/meroxa-environments-list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
createdAt:
updatedAt:
title: "meroxa environments list"
slug: meroxa-environments-list
url: /cli/cmd/meroxa-environments-list/
---
## meroxa environments list

List environments

```
meroxa environments list [flags]
```

### Options

```
-h, --help help for list
--no-headers display output without headers
```

### Options inherited from parent commands

```
--cli-config-file string meroxa configuration file
--debug display any debugging information
--json output json
--timeout duration set the duration of the client timeout in seconds (default 10s)
```

### SEE ALSO

* [meroxa environments](/cli/cmd/meroxa-environments/) - Manage environments on Meroxa

Loading

0 comments on commit 44d29a0

Please sign in to comment.