From ec3148d695724bb917e4e0ab168b3c35a6a99037 Mon Sep 17 00:00:00 2001 From: Ben Jackson Date: Tue, 6 Aug 2024 15:47:18 +1000 Subject: [PATCH] docs: remove unused documentation references (#367) --- .../commands/lagoon_add_project-rocketchat.md | 41 ----------------- docs/commands/lagoon_add_project-slack.md | 41 ----------------- docs/commands/lagoon_add_restore.md | 42 ------------------ docs/commands/lagoon_add_rocketchat.md | 44 ------------------- docs/commands/lagoon_add_slack.md | 44 ------------------- docs/commands/lagoon_add_variable.md | 43 ------------------ .../lagoon_delete_project-by-metadata.md | 40 ----------------- docs/commands/lagoon_delete_project-email.md | 40 ----------------- .../lagoon_delete_project-microsoftteams.md | 40 ----------------- .../lagoon_delete_project-rocketchat.md | 40 ----------------- docs/commands/lagoon_delete_project-slack.md | 40 ----------------- .../commands/lagoon_delete_project-webhook.md | 40 ----------------- docs/commands/lagoon_delete_rocketchat.md | 40 ----------------- docs/commands/lagoon_delete_slack.md | 40 ----------------- .../lagoon_get_project-by-metadata.md | 41 ----------------- .../lagoon_list_project-by-metadata.md | 41 ----------------- docs/commands/lagoon_list_rocketchat.md | 39 ---------------- docs/commands/lagoon_list_slack.md | 39 ---------------- docs/commands/lagoon_list_users.md | 40 ----------------- .../lagoon_update_project-by-metadata.md | 41 ----------------- docs/commands/lagoon_update_rocketchat.md | 44 ------------------- docs/commands/lagoon_update_slack.md | 44 ------------------- 22 files changed, 904 deletions(-) delete mode 100644 docs/commands/lagoon_add_project-rocketchat.md delete mode 100644 docs/commands/lagoon_add_project-slack.md delete mode 100644 docs/commands/lagoon_add_restore.md delete mode 100644 docs/commands/lagoon_add_rocketchat.md delete mode 100644 docs/commands/lagoon_add_slack.md delete mode 100644 docs/commands/lagoon_add_variable.md delete mode 100644 docs/commands/lagoon_delete_project-by-metadata.md delete mode 100644 docs/commands/lagoon_delete_project-email.md delete mode 100644 docs/commands/lagoon_delete_project-microsoftteams.md delete mode 100644 docs/commands/lagoon_delete_project-rocketchat.md delete mode 100644 docs/commands/lagoon_delete_project-slack.md delete mode 100644 docs/commands/lagoon_delete_project-webhook.md delete mode 100644 docs/commands/lagoon_delete_rocketchat.md delete mode 100644 docs/commands/lagoon_delete_slack.md delete mode 100644 docs/commands/lagoon_get_project-by-metadata.md delete mode 100644 docs/commands/lagoon_list_project-by-metadata.md delete mode 100644 docs/commands/lagoon_list_rocketchat.md delete mode 100644 docs/commands/lagoon_list_slack.md delete mode 100644 docs/commands/lagoon_list_users.md delete mode 100644 docs/commands/lagoon_update_project-by-metadata.md delete mode 100644 docs/commands/lagoon_update_rocketchat.md delete mode 100644 docs/commands/lagoon_update_slack.md diff --git a/docs/commands/lagoon_add_project-rocketchat.md b/docs/commands/lagoon_add_project-rocketchat.md deleted file mode 100644 index 346a7962..00000000 --- a/docs/commands/lagoon_add_project-rocketchat.md +++ /dev/null @@ -1,41 +0,0 @@ -## lagoon add project-rocketchat - -Add a Rocket.Chat notification to a project - -### Synopsis - -Add a Rocket.Chat notification to a project -This command is used to add an existing Rocket.Chat notification in Lagoon to a project. - -``` -lagoon add project-rocketchat [flags] -``` - -### Options - -``` - -h, --help help for project-rocketchat - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon add](lagoon_add.md) - Add a project, or add notifications and variables to projects or environments - diff --git a/docs/commands/lagoon_add_project-slack.md b/docs/commands/lagoon_add_project-slack.md deleted file mode 100644 index 1252eab7..00000000 --- a/docs/commands/lagoon_add_project-slack.md +++ /dev/null @@ -1,41 +0,0 @@ -## lagoon add project-slack - -Add a Slack notification to a project - -### Synopsis - -Add a Slack notification to a project -This command is used to add an existing Slack notification in Lagoon to a project. - -``` -lagoon add project-slack [flags] -``` - -### Options - -``` - -h, --help help for project-slack - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon add](lagoon_add.md) - Add a project, or add notifications and variables to projects or environments - diff --git a/docs/commands/lagoon_add_restore.md b/docs/commands/lagoon_add_restore.md deleted file mode 100644 index d0af9e87..00000000 --- a/docs/commands/lagoon_add_restore.md +++ /dev/null @@ -1,42 +0,0 @@ -## lagoon add restore - -Restore a backup - -### Synopsis - -Restore a backup -Given a backup-id, you can initiate a restore for it. -You can check the status of the backup using the list backups or get backup command. - -``` -lagoon add restore [flags] -``` - -### Options - -``` - -B, --backup-id string The backup ID you want to restore - -h, --help help for restore -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon add](lagoon_add.md) - Add a project, or add notifications and variables to projects or environments - diff --git a/docs/commands/lagoon_add_rocketchat.md b/docs/commands/lagoon_add_rocketchat.md deleted file mode 100644 index 0ee19004..00000000 --- a/docs/commands/lagoon_add_rocketchat.md +++ /dev/null @@ -1,44 +0,0 @@ -## lagoon add rocketchat - -Add a new Rocket.Chat notification - -### Synopsis - -Add a new Rocket.Chat notification -This command is used to set up a new Rocket.Chat notification in Lagoon. This requires information to talk to Rocket.Chat like the webhook URL and the name of the channel. -It does not configure a project to send notifications to Rocket.Chat though, you need to use project-rocketchat for that. - -``` -lagoon add rocketchat [flags] -``` - -### Options - -``` - -c, --channel string The channel for the notification - -h, --help help for rocketchat - -n, --name string The name of the notification - -w, --webhook string The webhook URL of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon add](lagoon_add.md) - Add a project, or add notifications and variables to projects or environments - diff --git a/docs/commands/lagoon_add_slack.md b/docs/commands/lagoon_add_slack.md deleted file mode 100644 index 5c10a24d..00000000 --- a/docs/commands/lagoon_add_slack.md +++ /dev/null @@ -1,44 +0,0 @@ -## lagoon add slack - -Add a new Slack notification - -### Synopsis - -Add a new Slack notification -This command is used to set up a new Slack notification in Lagoon. This requires information to talk to Slack like the webhook URL and the name of the channel. -It does not configure a project to send notifications to Slack though, you need to use project-slack for that. - -``` -lagoon add slack [flags] -``` - -### Options - -``` - -c, --channel string The channel for the notification - -h, --help help for slack - -n, --name string The name of the notification - -w, --webhook string The webhook URL of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon add](lagoon_add.md) - Add a project, or add notifications and variables to projects or environments - diff --git a/docs/commands/lagoon_add_variable.md b/docs/commands/lagoon_add_variable.md deleted file mode 100644 index c95d3d90..00000000 --- a/docs/commands/lagoon_add_variable.md +++ /dev/null @@ -1,43 +0,0 @@ -## lagoon add variable - -Add a variable to an environment or project - -### Synopsis - -Add a variable to an environment or project - -``` -lagoon add variable [flags] -``` - -### Options - -``` - -h, --help help for variable - -j, --json string JSON string to patch - -N, --name string Name of the variable to add - -S, --scope string Scope of the variable[global, build, runtime, container_registry, internal_container_registry] - -V, --value string Value of the variable to add -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon add](lagoon_add.md) - Add a project, or add notifications and variables to projects or environments - diff --git a/docs/commands/lagoon_delete_project-by-metadata.md b/docs/commands/lagoon_delete_project-by-metadata.md deleted file mode 100644 index 66bf1aca..00000000 --- a/docs/commands/lagoon_delete_project-by-metadata.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete project-by-metadata - -Delete a key from a projects metadata - -### Synopsis - -Delete a key from a projects metadata - -``` -lagoon delete project-by-metadata [flags] -``` - -### Options - -``` - -h, --help help for project-by-metadata - --key string The key name of the metadata value you are querying on -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_delete_project-email.md b/docs/commands/lagoon_delete_project-email.md deleted file mode 100644 index 030d9eec..00000000 --- a/docs/commands/lagoon_delete_project-email.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete project-email - -Delete a Email notification from a project - -### Synopsis - -Delete a Email notification from a project - -``` -lagoon delete project-email [flags] -``` - -### Options - -``` - -h, --help help for project-email - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_delete_project-microsoftteams.md b/docs/commands/lagoon_delete_project-microsoftteams.md deleted file mode 100644 index d593daa0..00000000 --- a/docs/commands/lagoon_delete_project-microsoftteams.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete project-microsoftteams - -Delete a MicrosoftTeams notification from a project - -### Synopsis - -Delete a MicrosoftTeams notification from a project - -``` -lagoon delete project-microsoftteams [flags] -``` - -### Options - -``` - -h, --help help for project-microsoftteams - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_delete_project-rocketchat.md b/docs/commands/lagoon_delete_project-rocketchat.md deleted file mode 100644 index a1c16850..00000000 --- a/docs/commands/lagoon_delete_project-rocketchat.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete project-rocketchat - -Delete a Rocket.Chat notification from a project - -### Synopsis - -Delete a Rocket.Chat notification from a project - -``` -lagoon delete project-rocketchat [flags] -``` - -### Options - -``` - -h, --help help for project-rocketchat - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_delete_project-slack.md b/docs/commands/lagoon_delete_project-slack.md deleted file mode 100644 index 541063e1..00000000 --- a/docs/commands/lagoon_delete_project-slack.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete project-slack - -Delete a Slack notification from a project - -### Synopsis - -Delete a Slack notification from a project - -``` -lagoon delete project-slack [flags] -``` - -### Options - -``` - -h, --help help for project-slack - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_delete_project-webhook.md b/docs/commands/lagoon_delete_project-webhook.md deleted file mode 100644 index a0f34f36..00000000 --- a/docs/commands/lagoon_delete_project-webhook.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete project-webhook - -Delete a Webhook notification from a project - -### Synopsis - -Delete a Webhook notification from a project - -``` -lagoon delete project-webhook [flags] -``` - -### Options - -``` - -h, --help help for project-webhook - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_delete_rocketchat.md b/docs/commands/lagoon_delete_rocketchat.md deleted file mode 100644 index 90b1d0dd..00000000 --- a/docs/commands/lagoon_delete_rocketchat.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete rocketchat - -Delete a Rocket.Chat notification from Lagoon - -### Synopsis - -Delete a Rocket.Chat notification from Lagoon - -``` -lagoon delete rocketchat [flags] -``` - -### Options - -``` - -h, --help help for rocketchat - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_delete_slack.md b/docs/commands/lagoon_delete_slack.md deleted file mode 100644 index b53a07e3..00000000 --- a/docs/commands/lagoon_delete_slack.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon delete slack - -Delete a Slack notification from Lagoon - -### Synopsis - -Delete a Slack notification from Lagoon - -``` -lagoon delete slack [flags] -``` - -### Options - -``` - -h, --help help for slack - -n, --name string The name of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon delete](lagoon_delete.md) - Delete a project, or delete notifications and variables from projects or environments - diff --git a/docs/commands/lagoon_get_project-by-metadata.md b/docs/commands/lagoon_get_project-by-metadata.md deleted file mode 100644 index f0d0679c..00000000 --- a/docs/commands/lagoon_get_project-by-metadata.md +++ /dev/null @@ -1,41 +0,0 @@ -## lagoon get project-by-metadata - -Query lagoon projects by a given metadata key or key:value - -### Synopsis - -Query lagoon projects by a given metadata key or key:value - -``` -lagoon get project-by-metadata [flags] -``` - -### Options - -``` - -h, --help help for project-by-metadata - --key string The key name of the metadata value you are querying on - --value string The value for the key you are querying on -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon get](lagoon_get.md) - Get info on a resource - diff --git a/docs/commands/lagoon_list_project-by-metadata.md b/docs/commands/lagoon_list_project-by-metadata.md deleted file mode 100644 index 74c6ebed..00000000 --- a/docs/commands/lagoon_list_project-by-metadata.md +++ /dev/null @@ -1,41 +0,0 @@ -## lagoon list project-by-metadata - -List projects by a given metadata key or key:value - -### Synopsis - -List projects by a given metadata key or key:value - -``` -lagoon list project-by-metadata [flags] -``` - -### Options - -``` - -h, --help help for project-by-metadata - --key string The key name of the metadata value you are querying on - --value string The value for the key you are querying on -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon list](lagoon_list.md) - List projects, deployments, variables or notifications - diff --git a/docs/commands/lagoon_list_rocketchat.md b/docs/commands/lagoon_list_rocketchat.md deleted file mode 100644 index 15e3b129..00000000 --- a/docs/commands/lagoon_list_rocketchat.md +++ /dev/null @@ -1,39 +0,0 @@ -## lagoon list rocketchat - -List Rocket.Chat details about a project (alias: r) - -### Synopsis - -List Rocket.Chat details about a project (alias: r) - -``` -lagoon list rocketchat [flags] -``` - -### Options - -``` - -h, --help help for rocketchat -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon list](lagoon_list.md) - List projects, deployments, variables or notifications - diff --git a/docs/commands/lagoon_list_slack.md b/docs/commands/lagoon_list_slack.md deleted file mode 100644 index ab67a6cc..00000000 --- a/docs/commands/lagoon_list_slack.md +++ /dev/null @@ -1,39 +0,0 @@ -## lagoon list slack - -List Slack details about a project (alias: s) - -### Synopsis - -List Slack details about a project (alias: s) - -``` -lagoon list slack [flags] -``` - -### Options - -``` - -h, --help help for slack -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon list](lagoon_list.md) - List projects, deployments, variables or notifications - diff --git a/docs/commands/lagoon_list_users.md b/docs/commands/lagoon_list_users.md deleted file mode 100644 index 7988ae11..00000000 --- a/docs/commands/lagoon_list_users.md +++ /dev/null @@ -1,40 +0,0 @@ -## lagoon list users - -List all users in groups (alias: u) - -### Synopsis - -List all users in groups in lagoon, this only shows users that are in groups. - -``` -lagoon list users [flags] -``` - -### Options - -``` - -h, --help help for users - -N, --name string Name of the group to list users in (if not specified, will default to all groups) -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon list](lagoon_list.md) - List projects, environments, deployments, variables or notifications - diff --git a/docs/commands/lagoon_update_project-by-metadata.md b/docs/commands/lagoon_update_project-by-metadata.md deleted file mode 100644 index 3d29503f..00000000 --- a/docs/commands/lagoon_update_project-by-metadata.md +++ /dev/null @@ -1,41 +0,0 @@ -## lagoon update project-by-metadata - -Update a projects metadata with a given key or key:value - -### Synopsis - -Update a projects metadata with a given key or key:value - -``` -lagoon update project-by-metadata [flags] -``` - -### Options - -``` - -h, --help help for project-by-metadata - --key string The key name of the metadata value you are querying on - --value string The value for the key you are querying on -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon update](lagoon_update.md) - Update a resource - diff --git a/docs/commands/lagoon_update_rocketchat.md b/docs/commands/lagoon_update_rocketchat.md deleted file mode 100644 index bedbd37f..00000000 --- a/docs/commands/lagoon_update_rocketchat.md +++ /dev/null @@ -1,44 +0,0 @@ -## lagoon update rocketchat - -Update an existing Rocket.Chat notification - -### Synopsis - -Update an existing Rocket.Chat notification - -``` -lagoon update rocketchat [flags] -``` - -### Options - -``` - -c, --channel string The channel for the notification - -h, --help help for rocketchat - -j, --json string JSON string to patch - -n, --name string The current name of the notification - -N, --newname string The name of the notification - -w, --webhook string The webhook URL of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon update](lagoon_update.md) - Update a resource - diff --git a/docs/commands/lagoon_update_slack.md b/docs/commands/lagoon_update_slack.md deleted file mode 100644 index c242d822..00000000 --- a/docs/commands/lagoon_update_slack.md +++ /dev/null @@ -1,44 +0,0 @@ -## lagoon update slack - -Update an existing Slack notification - -### Synopsis - -Update an existing Slack notification - -``` -lagoon update slack [flags] -``` - -### Options - -``` - -c, --channel string The channel for the notification - -h, --help help for slack - -j, --json string JSON string to patch - -n, --name string The current name of the notification - -N, --newname string The name of the notification - -w, --webhook string The webhook URL of the notification -``` - -### Options inherited from parent commands - -``` - --config-file string Path to the config file to use (must be *.yml or *.yaml) - --debug Enable debugging output (if supported) - -e, --environment string Specify an environment to use - --force Force yes on prompts (if supported) - -l, --lagoon string The Lagoon instance to interact with - --no-header No header on table (if supported) - --output-csv Output as CSV (if supported) - --output-json Output as JSON (if supported) - --pretty Make JSON pretty (if supported) - -p, --project string Specify a project to use - --skip-update-check Skip checking for updates - -i, --ssh-key string Specify path to a specific SSH key to use for lagoon authentication -``` - -### SEE ALSO - -* [lagoon update](lagoon_update.md) - Update a resource -