From b4f72d24199c1624e2ef6086fe918939e2b282d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ra=C3=BAl=20Barroso?= Date: Fri, 11 Feb 2022 13:25:56 +0100 Subject: [PATCH] chore(environments): Add missing docs Follow up of https://github.com/meroxa/cli/pull/254 --- docs/cmd/md/meroxa_environments.md | 1 + docs/cmd/md/meroxa_environments_repair.md | 31 +++++++++++++++ docs/cmd/www/meroxa-environments-repair.md | 38 ++++++++++++++++++ docs/cmd/www/meroxa-environments.md | 1 + etc/completion/meroxa.completion.sh | 29 ++++++++++++++ etc/man/man1/meroxa-environments-repair.1 | 45 ++++++++++++++++++++++ etc/man/man1/meroxa-environments.1 | 2 +- 7 files changed, 146 insertions(+), 1 deletion(-) create mode 100644 docs/cmd/md/meroxa_environments_repair.md create mode 100644 docs/cmd/www/meroxa-environments-repair.md create mode 100644 etc/man/man1/meroxa-environments-repair.1 diff --git a/docs/cmd/md/meroxa_environments.md b/docs/cmd/md/meroxa_environments.md index 214321822..a6aefd61c 100644 --- a/docs/cmd/md/meroxa_environments.md +++ b/docs/cmd/md/meroxa_environments.md @@ -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 diff --git a/docs/cmd/md/meroxa_environments_repair.md b/docs/cmd/md/meroxa_environments_repair.md new file mode 100644 index 000000000..b30fe494f --- /dev/null +++ b/docs/cmd/md/meroxa_environments_repair.md @@ -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 + diff --git a/docs/cmd/www/meroxa-environments-repair.md b/docs/cmd/www/meroxa-environments-repair.md new file mode 100644 index 000000000..d24e7438c --- /dev/null +++ b/docs/cmd/www/meroxa-environments-repair.md @@ -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 + diff --git a/docs/cmd/www/meroxa-environments.md b/docs/cmd/www/meroxa-environments.md index 7655709f4..e2a0bf68b 100644 --- a/docs/cmd/www/meroxa-environments.md +++ b/docs/cmd/www/meroxa-environments.md @@ -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 diff --git a/etc/completion/meroxa.completion.sh b/etc/completion/meroxa.completion.sh index 9fae8f41e..441dbceb5 100644 --- a/etc/completion/meroxa.completion.sh +++ b/etc/completion/meroxa.completion.sh @@ -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" @@ -1380,6 +1408,7 @@ _meroxa_environments() command_aliases+=("rm") aliashash["rm"]="remove" fi + commands+=("repair") commands+=("update") flags=() diff --git a/etc/man/man1/meroxa-environments-repair.1 b/etc/man/man1/meroxa-environments-repair.1 new file mode 100644 index 000000000..0fbd1f9c1 --- /dev/null +++ b/etc/man/man1/meroxa-environments-repair.1 @@ -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 diff --git a/etc/man/man1/meroxa-environments.1 b/etc/man/man1/meroxa-environments.1 index c02242d32..47580be38 100644 --- a/etc/man/man1/meroxa-environments.1 +++ b/etc/man/man1/meroxa-environments.1 @@ -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