From 59e792520b076d306fb56e91ee1e1f13d071b282 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 16 Nov 2023 17:45:35 +0200 Subject: [PATCH] Auto-generated cli documentation update - 2023-11-16 17:40:44 (#1683) Update documentation Co-authored-by: rdimitrov --- docs/docs/ref/cli/minder.md | 1 + docs/docs/ref/cli/minder_provider_enroll.md | 10 ++--- docs/docs/ref/cli/minder_quickstart.md | 41 +++++++++++++++++++++ 3 files changed, 47 insertions(+), 5 deletions(-) create mode 100644 docs/docs/ref/cli/minder_quickstart.md diff --git a/docs/docs/ref/cli/minder.md b/docs/docs/ref/cli/minder.md index ce6682b19d..13a2fb179f 100644 --- a/docs/docs/ref/cli/minder.md +++ b/docs/docs/ref/cli/minder.md @@ -32,6 +32,7 @@ https://docs.stacklok.com/minder * [minder profile](minder_profile.md) - Manage profiles within a minder control plane * [minder profile_status](minder_profile_status.md) - Manage profile status within a minder control plane * [minder provider](minder_provider.md) - Manage providers within a minder control plane +* [minder quickstart](minder_quickstart.md) - Quickstart minder * [minder repo](minder_repo.md) - Manage repositories within a minder control plane * [minder rule_type](minder_rule_type.md) - Manage rule types within a minder control plane * [minder version](minder_version.md) - Print the version of the minder CLI diff --git a/docs/docs/ref/cli/minder_provider_enroll.md b/docs/docs/ref/cli/minder_provider_enroll.md index bb1813cf2e..f4faa891be 100644 --- a/docs/docs/ref/cli/minder_provider_enroll.md +++ b/docs/docs/ref/cli/minder_provider_enroll.md @@ -18,11 +18,11 @@ minder provider enroll [flags] ### Options ``` - -h, --help help for enroll - -o, --owner string Owner to filter on for provider resources - -g, --project-id string ID of the project for enrolling the provider - -p, --provider string Name for the provider to enroll - -t, --token string Personal Access Token (PAT) to use for enrollment + -h, --help help for enroll + -o, --owner string Owner to filter on for provider resources + -r, --project string ID of the project for enrolling the provider + -p, --provider string Name for the provider to enroll + -t, --token string Personal Access Token (PAT) to use for enrollment ``` ### Options inherited from parent commands diff --git a/docs/docs/ref/cli/minder_quickstart.md b/docs/docs/ref/cli/minder_quickstart.md new file mode 100644 index 0000000000..59358b56be --- /dev/null +++ b/docs/docs/ref/cli/minder_quickstart.md @@ -0,0 +1,41 @@ +--- +title: minder quickstart +--- +## minder quickstart + +Quickstart minder + +### Synopsis + +The quickstart command provide the means to quickly get started with minder + +``` +minder quickstart [flags] +``` + +### Options + +``` + -h, --help help for quickstart + -o, --owner string Owner to filter on for provider resources + -r, --project string Project to create the quickstart profile in + -p, --provider string Name of the provider (default "github") + -t, --token string Personal Access Token (PAT) to use for enrollment +``` + +### Options inherited from parent commands + +``` + --config string Config file (default is $PWD/config.yaml) + --grpc-host string Server host (default "api.stacklok.com") + --grpc-insecure Allow establishing insecure connections + --grpc-port int Server port (default 443) + --identity-client string Identity server client ID (default "minder-cli") + --identity-realm string Identity server realm (default "stacklok") + --identity-url string Identity server issuer URL (default "https://auth.stacklok.com") +``` + +### SEE ALSO + +* [minder](minder.md) - Minder controls the hosted minder service +