Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate docs for web #122

Merged
merged 4 commits into from
Apr 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ test:

.PHONY: docs
docs:
rm -rf docs/cmd && mkdir docs/cmd
rm -rf docs/cmd && mkdir -p docs/cmd/{md,www}
rm -rf etc && mkdir -p etc/man/man1 && mkdir -p etc/completion
go run gen-docs/main.go
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ make test

If you want to enable shell completion manually, you can generate your own using our `meroxa completion` command.

Type `meroxa help completion` for more information, or simply take a look at our [documentation](docs/cmd/meroxa_completion.md).
Type `meroxa help completion` for more information, or simply take a look at our [documentation](docs/cmd/md/meroxa_completion.md).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
53 changes: 53 additions & 0 deletions docs/cmd/www/meroxa-add-resource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
createdAt: 2021-04-15T17:48:51+02:00
updatedAt: 2021-04-15T17:48:51+02:00
title: "meroxa add resource"
slug: meroxa-add-resource
url: /cli/meroxa-add-resource/
---
## meroxa add resource

Add a resource to your Meroxa resource catalog

### Synopsis

Use the add command to add resources to your Meroxa resource catalog.

```
meroxa add resource [NAME] --type TYPE [flags]
```

### Examples

```

meroxa add resource store --type postgres -u $DATABASE_URL --metadata '{"logical_replication":true}'
meroxa add resource datalake --type s3 -u "s3://$AWS_ACCESS_KEY_ID:$AWS_ACCESS_KEY_SECRET@us-east-1/meroxa-demos"
meroxa add resource warehouse --type redshift -u $REDSHIFT_URL
meroxa add resource slack --type url -u $WEBHOOK_URL

```

### Options

```
--credentials string resource credentials
-h, --help help for resource
-m, --metadata string resource metadata
--type string resource type
-u, --url string resource url
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/meroxa.env)
--debug display any debugging information
--json output json
--timeout duration set the client timeout (default 10s)
```

### SEE ALSO

* [meroxa add](/cli/meroxa-add/) - Add a resource to your Meroxa resource catalog

31 changes: 31 additions & 0 deletions docs/cmd/www/meroxa-add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
createdAt: 2021-04-15T17:48:51+02:00
updatedAt: 2021-04-15T17:48:51+02:00
title: "meroxa add"
slug: meroxa-add
url: /cli/meroxa-add/
---
## meroxa add

Add a resource to your Meroxa resource catalog

### Options

```
-h, --help help for add
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/meroxa.env)
--debug display any debugging information
--json output json
--timeout duration set the client timeout (default 10s)
```

### SEE ALSO

* [meroxa](/cli/meroxa/) - The Meroxa CLI
* [meroxa add resource](/cli/meroxa-add-resource/) - Add a resource to your Meroxa resource catalog

42 changes: 42 additions & 0 deletions docs/cmd/www/meroxa-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
createdAt: 2021-04-15T17:48:51+02:00
updatedAt: 2021-04-15T17:48:51+02:00
title: "meroxa api"
slug: meroxa-api
url: /cli/meroxa-api/
---
## meroxa api

Invoke Meroxa API

```
meroxa api METHOD PATH [body] [flags]
```

### Examples

```

meroxa api GET /v1/endpoints
meroxa api POST /v1/endpoints '{"protocol": "HTTP", "stream": "resource-2-499379-public.accounts", "name": "1234"}'
```

### Options

```
-h, --help help for api
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/meroxa.env)
--debug display any debugging information
--json output json
--timeout duration set the client timeout (default 10s)
```

### SEE ALSO

* [meroxa](/cli/meroxa/) - The Meroxa CLI

34 changes: 34 additions & 0 deletions docs/cmd/www/meroxa-billing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
createdAt: 2021-04-15T17:48:51+02:00
updatedAt: 2021-04-15T17:48:51+02:00
title: "meroxa billing"
slug: meroxa-billing
url: /cli/meroxa-billing/
---
## meroxa billing

Open your billing page in a web browser

```
meroxa billing [flags]
```

### Options

```
-h, --help help for billing
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/meroxa.env)
--debug display any debugging information
--json output json
--timeout duration set the client timeout (default 10s)
```

### SEE ALSO

* [meroxa](/cli/meroxa/) - The Meroxa CLI

68 changes: 68 additions & 0 deletions docs/cmd/www/meroxa-completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
createdAt: 2021-04-15T17:48:51+02:00
updatedAt: 2021-04-15T17:48:51+02:00
title: "meroxa completion"
slug: meroxa-completion
url: /cli/meroxa-completion/
---
## meroxa completion

Generate completion script

### Synopsis

To load completions:

Bash:

$ source <(meroxa completion bash)

# To load completions for each session, execute once:
Linux:
$ meroxa completion bash > /etc/bash_completion.d/meroxa
MacOS:
$ meroxa completion bash > /usr/local/etc/bash_completion.d/meroxa

Zsh:

# If shell completion is not already enabled in your environment you will need
# to enable it. You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

# To load completions for each session, execute once:
$ meroxa completion zsh > "${fpath[1]}/_meroxa"

# You will need to start a new shell for this setup to take effect.

Fish:

$ meroxa completion fish | source

# To load completions for each session, execute once:
$ meroxa completion fish > ~/.config/fish/completions/meroxa.fish


```
meroxa completion [bash|zsh|fish|powershell]
```

### Options

```
-h, --help help for completion
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/meroxa.env)
--debug display any debugging information
--json output json
--timeout duration set the client timeout (default 10s)
```

### SEE ALSO

* [meroxa](/cli/meroxa/) - The Meroxa CLI

54 changes: 54 additions & 0 deletions docs/cmd/www/meroxa-connect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
createdAt: 2021-04-15T17:48:51+02:00
updatedAt: 2021-04-15T17:48:51+02:00
title: "meroxa connect"
slug: meroxa-connect
url: /cli/meroxa-connect/
---
## meroxa connect

Connect two resources together

### Synopsis

Use the connect command to automatically configure the connectors required to pull data from one resource
(source) to another (destination).

This command is equivalent to creating two connectors separately, one from the source to Meroxa and another from Meroxa
to the destination:

meroxa connect --from RESOURCE-NAME --to RESOURCE-NAME --input SOURCE-INPUT

or

meroxa create connector --from postgres --input accounts # Creates source connector
meroxa create connector --to redshift --input orders # Creates destination connector


```
meroxa connect --from RESOURCE-NAME --to RESOURCE-NAME [flags]
```

### Options

```
--from string source resource name
-h, --help help for connect
--input string command delimeted list of input streams
--pipeline string pipeline name to attach connectors to
--to string destination resource name
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/meroxa.env)
--debug display any debugging information
--json output json
--timeout duration set the client timeout (default 10s)
```

### SEE ALSO

* [meroxa](/cli/meroxa/) - The Meroxa CLI

52 changes: 52 additions & 0 deletions docs/cmd/www/meroxa-create-connector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
createdAt: 2021-04-15T17:48:51+02:00
updatedAt: 2021-04-15T17:48:51+02:00
title: "meroxa create connector"
slug: meroxa-create-connector
url: /cli/meroxa-create-connector/
---
## meroxa create connector

Create a connector

### Synopsis

Use create connector to create a connector from a source (--from) or to a destination (--to)

```
meroxa create connector [NAME] [flags]
```

### Examples

```

meroxa create connector [NAME] --from pg2kafka --input accounts
meroxa create connector [NAME] --to pg2redshift --input orders # --input will be the desired stream
meroxa create connector [NAME] --to pg2redshift --input orders --pipeline my-pipeline

```

### Options

```
--from string resource name to use as source
-h, --help help for connector
--input string command delimited list of input streams
--pipeline string pipeline name to attach connector to
--to string resource name to use as destination
```

### Options inherited from parent commands

```
--config string config file (default is $HOME/meroxa.env)
--debug display any debugging information
--json output json
--timeout duration set the client timeout (default 10s)
```

### SEE ALSO

* [meroxa create](/cli/meroxa-create/) - Create Meroxa pipeline components

Loading