Skip to content

Commit

Permalink
chore(environments): Add missing docs (#255)
Browse files Browse the repository at this point in the history
Follow up of #254
  • Loading branch information
raulb authored Feb 11, 2022
1 parent 4d88738 commit 5590e3e
Show file tree
Hide file tree
Showing 7 changed files with 146 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/cmd/md/meroxa_environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ Manage environments on Meroxa
* [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 repair](meroxa_environments_repair.md) - Repair environment
* [meroxa environments update](meroxa_environments_update.md) - Update an environment

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

Repair environment

### Synopsis

Repair any environment that is in one of the following states: provisioning_error, deprovisioning_error, repairing_error.

```
meroxa environments repair NAMEorUUID [flags]
```

### Options

```
-h, --help help for repair
```

### 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/www/meroxa-environments-repair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
createdAt:
updatedAt:
title: "meroxa environments repair"
slug: meroxa-environments-repair
url: /cli/cmd/meroxa-environments-repair/
---
## meroxa environments repair

Repair environment

### Synopsis

Repair any environment that is in one of the following states: provisioning_error, deprovisioning_error, repairing_error.

```
meroxa environments repair NAMEorUUID [flags]
```

### Options

```
-h, --help help for repair
```

### 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

1 change: 1 addition & 0 deletions docs/cmd/www/meroxa-environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ Manage environments on Meroxa
* [meroxa environments describe](/cli/cmd/meroxa-environments-describe/) - Describe environment
* [meroxa environments list](/cli/cmd/meroxa-environments-list/) - List environments
* [meroxa environments remove](/cli/cmd/meroxa-environments-remove/) - Remove environment
* [meroxa environments repair](/cli/cmd/meroxa-environments-repair/) - Repair environment
* [meroxa environments update](/cli/cmd/meroxa-environments-update/) - Update an environment

29 changes: 29 additions & 0 deletions etc/completion/meroxa.completion.sh
Original file line number Diff line number Diff line change
Expand Up @@ -1323,6 +1323,34 @@ _meroxa_environments_remove()
noun_aliases=()
}

_meroxa_environments_repair()
{
last_command="meroxa_environments_repair"

command_aliases=()

commands=()

flags=()
two_word_flags=()
local_nonpersistent_flags=()
flags_with_completion=()
flags_completion=()

flags+=("--help")
flags+=("-h")
flags+=("--cli-config-file=")
two_word_flags+=("--cli-config-file")
flags+=("--debug")
flags+=("--json")
flags+=("--timeout=")
two_word_flags+=("--timeout")

must_have_one_flag=()
must_have_one_noun=()
noun_aliases=()
}

_meroxa_environments_update()
{
last_command="meroxa_environments_update"
Expand Down Expand Up @@ -1380,6 +1408,7 @@ _meroxa_environments()
command_aliases+=("rm")
aliashash["rm"]="remove"
fi
commands+=("repair")
commands+=("update")

flags=()
Expand Down
45 changes: 45 additions & 0 deletions etc/man/man1/meroxa-environments-repair.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.nh
.TH "Meroxa" "1" "Feb 2022" "Meroxa CLI " "Meroxa Manual"

.SH NAME
.PP
meroxa\-environments\-repair \- Repair environment


.SH SYNOPSIS
.PP
\fBmeroxa environments repair NAMEorUUID [flags]\fP


.SH DESCRIPTION
.PP
Repair any environment that is in one of the following states: provisioning\_error, deprovisioning\_error, repairing\_error.


.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for repair


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cli\-config\-file\fP=""
meroxa configuration file

.PP
\fB\-\-debug\fP[=false]
display any debugging information

.PP
\fB\-\-json\fP[=false]
output json

.PP
\fB\-\-timeout\fP=10s
set the duration of the client timeout in seconds


.SH SEE ALSO
.PP
\fBmeroxa\-environments(1)\fP
2 changes: 1 addition & 1 deletion etc/man/man1/meroxa-environments.1
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Manage environments on Meroxa

.SH SEE ALSO
.PP
\fBmeroxa(1)\fP, \fBmeroxa\-environments\-create(1)\fP, \fBmeroxa\-environments\-describe(1)\fP, \fBmeroxa\-environments\-list(1)\fP, \fBmeroxa\-environments\-remove(1)\fP, \fBmeroxa\-environments\-update(1)\fP
\fBmeroxa(1)\fP, \fBmeroxa\-environments\-create(1)\fP, \fBmeroxa\-environments\-describe(1)\fP, \fBmeroxa\-environments\-list(1)\fP, \fBmeroxa\-environments\-remove(1)\fP, \fBmeroxa\-environments\-repair(1)\fP, \fBmeroxa\-environments\-update(1)\fP

0 comments on commit 5590e3e

Please sign in to comment.