Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
justmisosoup committed Apr 15, 2022
1 parent 1603745 commit 1d2c7d6
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 18 deletions.
6 changes: 5 additions & 1 deletion docs/cmd/md/meroxa_apps_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@ Deploy a Meroxa Data Application

### Synopsis

This command will deploy the application specified in `--path`(or current working directory if not specified) to our Meroxa Platform.If deployment was successful, you should expect an application you'll be able to fully manage
This command will deploy the application specified in '--path'
(or current working directory if not specified) to our Meroxa Platform.
If deployment was successful, you should expect an application you'll be able to fully manage


```
meroxa apps deploy [flags]
Expand All @@ -15,6 +18,7 @@ meroxa apps deploy [flags]
```
meroxa apps deploy # assumes you run it from the app directory
meroxa apps deploy --path ./my-app
```

### Options
Expand Down
7 changes: 6 additions & 1 deletion docs/cmd/md/meroxa_apps_init.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ meroxa apps init [APP_NAME] [--path pwd] --lang js|go [flags]
### Examples

```
meroxa apps init my-app --path ~/code --lang jsmeroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directorymeroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.orgmeroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go modulemeroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory
meroxa apps init my-app --path ~/code --lang js
meroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directory
meroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go module
meroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory
meroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.org
```

### Options
Expand Down
8 changes: 4 additions & 4 deletions docs/cmd/md/meroxa_apps_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ Execute a Meroxa Data Application locally

### Synopsis

meroxa apps run will build your app locally to then run it
locally on --path.
meroxa apps run will build your app locally to then run it locally in --path.

```
meroxa apps run [flags]
Expand All @@ -14,8 +13,9 @@ meroxa apps run [flags]
### Examples

```
meroxa apps run # assumes you run it from the app directory
meroxa apps run --path ../js-demo --lang js # in case you didn't specify lang on your app.jsonmeroxa apps run --path ../go-demo # it'll use lang defined in your app.json
meroxa apps run # assumes you run it from the app directory
meroxa apps run --path ../go-demo # it'll use lang defined in your app.json
```

### Options
Expand Down
6 changes: 5 additions & 1 deletion docs/cmd/www/meroxa-apps-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,10 @@ Deploy a Meroxa Data Application

### Synopsis

This command will deploy the application specified in `--path`(or current working directory if not specified) to our Meroxa Platform.If deployment was successful, you should expect an application you'll be able to fully manage
This command will deploy the application specified in '--path'
(or current working directory if not specified) to our Meroxa Platform.
If deployment was successful, you should expect an application you'll be able to fully manage


```
meroxa apps deploy [flags]
Expand All @@ -22,6 +25,7 @@ meroxa apps deploy [flags]
```
meroxa apps deploy # assumes you run it from the app directory
meroxa apps deploy --path ./my-app
```

### Options
Expand Down
7 changes: 6 additions & 1 deletion docs/cmd/www/meroxa-apps-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@ meroxa apps init [APP_NAME] [--path pwd] --lang js|go [flags]
### Examples

```
meroxa apps init my-app --path ~/code --lang jsmeroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directorymeroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.orgmeroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go modulemeroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory
meroxa apps init my-app --path ~/code --lang js
meroxa apps init my-app --lang go # will be initialized in a dir called my-app in the current directory
meroxa apps init my-app --lang go --skip-mod-init # will not initialize the new go module
meroxa apps init my-app --lang go --mod-vendor # will initialize the new go module and download dependencies to the vendor directory
meroxa apps init my-app --lang go --path $GOPATH/src/github.com/my.org
```

### Options
Expand Down
8 changes: 4 additions & 4 deletions docs/cmd/www/meroxa-apps-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ Execute a Meroxa Data Application locally

### Synopsis

meroxa apps run will build your app locally to then run it
locally on --path.
meroxa apps run will build your app locally to then run it locally in --path.

```
meroxa apps run [flags]
Expand All @@ -21,8 +20,9 @@ meroxa apps run [flags]
### Examples

```
meroxa apps run # assumes you run it from the app directory
meroxa apps run --path ../js-demo --lang js # in case you didn't specify lang on your app.jsonmeroxa apps run --path ../go-demo # it'll use lang defined in your app.json
meroxa apps run # assumes you run it from the app directory
meroxa apps run --path ../go-demo # it'll use lang defined in your app.json
```

### Options
Expand Down
5 changes: 4 additions & 1 deletion etc/man/man1/meroxa-apps-deploy.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ meroxa\-apps\-deploy \- Deploy a Meroxa Data Application

.SH DESCRIPTION
.PP
This command will deploy the application specified in \fB\fC\-\-path\fR(or current working directory if not specified) to our Meroxa Platform.If deployment was successful, you should expect an application you'll be able to fully manage
This command will deploy the application specified in '\-\-path'
(or current working directory if not specified) to our Meroxa Platform.
If deployment was successful, you should expect an application you'll be able to fully manage


.SH OPTIONS
Expand Down Expand Up @@ -51,6 +53,7 @@ This command will deploy the application specified in \fB\fC\-\-path\fR(or curre
meroxa apps deploy # assumes you run it from the app directory
meroxa apps deploy \-\-path ./my\-app


.fi
.RE

Expand Down
7 changes: 6 additions & 1 deletion etc/man/man1/meroxa-apps-init.1
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,12 @@ Initialize a Meroxa Data Application
.RS

.nf
meroxa apps init my\-app \-\-path \~/code \-\-lang jsmeroxa apps init my\-app \-\-lang go # will be initialized in a dir called my\-app in the current directorymeroxa apps init my\-app \-\-lang go \-\-path $GOPATH/src/github.com/my.orgmeroxa apps init my\-app \-\-lang go \-\-skip\-mod\-init # will not initialize the new go modulemeroxa apps init my\-app \-\-lang go \-\-mod\-vendor # will initialize the new go module and download dependencies to the vendor directory
meroxa apps init my\-app \-\-path \~/code \-\-lang js
meroxa apps init my\-app \-\-lang go # will be initialized in a dir called my\-app in the current directory
meroxa apps init my\-app \-\-lang go \-\-skip\-mod\-init # will not initialize the new go module
meroxa apps init my\-app \-\-lang go \-\-mod\-vendor # will initialize the new go module and download dependencies to the vendor directory
meroxa apps init my\-app \-\-lang go \-\-path $GOPATH/src/github.com/my.org


.fi
.RE
Expand Down
8 changes: 4 additions & 4 deletions etc/man/man1/meroxa-apps-run.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ meroxa\-apps\-run \- Execute a Meroxa Data Application locally

.SH DESCRIPTION
.PP
meroxa apps run will build your app locally to then run it
locally on \-\-path.
meroxa apps run will build your app locally to then run it locally in \-\-path.


.SH OPTIONS
Expand Down Expand Up @@ -54,8 +53,9 @@ locally on \-\-path.
.RS

.nf
meroxa apps run # assumes you run it from the app directory
meroxa apps run \-\-path ../js\-demo \-\-lang js # in case you didn't specify lang on your app.jsonmeroxa apps run \-\-path ../go\-demo # it'll use lang defined in your app.json
meroxa apps run # assumes you run it from the app directory
meroxa apps run \-\-path ../go\-demo # it'll use lang defined in your app.json


.fi
.RE
Expand Down

0 comments on commit 1d2c7d6

Please sign in to comment.