Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ericcheatham committed Sep 13, 2022
1 parent d334c77 commit 92a2806
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/cmd/md/meroxa_apps_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ meroxa apps deploy --path ./my-app
### Options

```
-h, --help help for deploy
--path string Path to the app directory (default is local directory)
-h, --help help for deploy
--path string Path to the app directory (default is local directory)
--skip-collection-validation Skips unique destination collection and looping validations
```

### Options inherited from parent commands
Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/md/meroxa_resources_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,14 @@ $ meroxa resource create snowflake \
-u "snowflake://$SNOWFLAKE_URL/meroxa_db/stream_data" \
--username meroxa_user \
--password $SNOWFLAKE_PRIVATE_KEY
$ meroxa resource create sourcedb \
--type kafka \
--url kafka+sasl+ssl://$KAFKA_USER:$KAFKA_PASS@<$BOOTSTRAP_SERVER>?sasl_mechanism=plain
$ meroxa resource create sourcedb \
--type confluentcloud \
--url kafka+sasl+ssl://$API_KEY:$API_SECRET@<$BOOTSTRAP_SERVER>?sasl_mechanism=plain
```

### Options
Expand Down
5 changes: 3 additions & 2 deletions docs/cmd/www/meroxa-apps-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ meroxa apps deploy --path ./my-app
### Options

```
-h, --help help for deploy
--path string Path to the app directory (default is local directory)
-h, --help help for deploy
--path string Path to the app directory (default is local directory)
--skip-collection-validation Skips unique destination collection and looping validations
```

### Options inherited from parent commands
Expand Down
8 changes: 8 additions & 0 deletions docs/cmd/www/meroxa-resources-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ $ meroxa resource create snowflake \
-u "snowflake://$SNOWFLAKE_URL/meroxa_db/stream_data" \
--username meroxa_user \
--password $SNOWFLAKE_PRIVATE_KEY
$ meroxa resource create sourcedb \
--type kafka \
--url kafka+sasl+ssl://$KAFKA_USER:$KAFKA_PASS@<$BOOTSTRAP_SERVER>?sasl_mechanism=plain
$ meroxa resource create sourcedb \
--type confluentcloud \
--url kafka+sasl+ssl://$API_KEY:$API_SECRET@<$BOOTSTRAP_SERVER>?sasl_mechanism=plain
```

### Options
Expand Down
1 change: 1 addition & 0 deletions etc/completion/meroxa.completion.sh
Original file line number Diff line number Diff line change
Expand Up @@ -406,6 +406,7 @@ _meroxa_apps_deploy()
flags+=("-h")
flags+=("--path=")
two_word_flags+=("--path")
flags+=("--skip-collection-validation")
flags+=("--cli-config-file=")
two_word_flags+=("--cli-config-file")
flags+=("--debug")
Expand Down
4 changes: 4 additions & 0 deletions etc/man/man1/meroxa-apps-deploy.1
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ If deployment was successful, you should expect an application you'll be able to
\fB--path\fP=""
Path to the app directory (default is local directory)

.PP
\fB--skip-collection-validation\fP[=false]
Skips unique destination collection and looping validations


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
Expand Down
8 changes: 8 additions & 0 deletions etc/man/man1/meroxa-resources-create.1
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,14 @@ $ meroxa resource create snowflake \\
--username meroxa_user \\
--password $SNOWFLAKE_PRIVATE_KEY

$ meroxa resource create sourcedb \\
--type kafka \\
--url kafka+sasl+ssl://$KAFKA_USER:$KAFKA_PASS@<$BOOTSTRAP_SERVER>?sasl_mechanism=plain

$ meroxa resource create sourcedb \\
--type confluentcloud \\
--url kafka+sasl+ssl://$API_KEY:$API_SECRET@<$BOOTSTRAP_SERVER>?sasl_mechanism=plain

.fi
.RE

Expand Down

0 comments on commit 92a2806

Please sign in to comment.