From dbbfa9ef6318c60f496c7b046145bf1fff24e054 Mon Sep 17 00:00:00 2001 From: Sergiu Ghitea Date: Sat, 3 Dec 2022 13:58:09 +0100 Subject: [PATCH] Update docs after branding command refactor --- docs/auth0_branding.md | 37 ------------------- docs/auth0_branding_domains.md | 37 ------------------- docs/auth0_branding_texts.md | 33 ----------------- docs/auth0_domains.md | 37 +++++++++++++++++++ ...ains_create.md => auth0_domains_create.md} | 10 ++--- ...ains_delete.md => auth0_domains_delete.md} | 10 ++--- ..._domains_list.md => auth0_domains_list.md} | 12 +++--- ..._domains_show.md => auth0_domains_show.md} | 10 ++--- ...ains_update.md => auth0_domains_update.md} | 12 +++--- ...ains_verify.md => auth0_domains_verify.md} | 10 ++--- docs/auth0_email.md | 32 ++++++++++++++++ ...ing_emails.md => auth0_email_templates.md} | 10 ++--- ..._show.md => auth0_email_templates_show.md} | 10 ++--- ...ate.md => auth0_email_templates_update.md} | 10 ++--- docs/auth0_universal-login.md | 35 ++++++++++++++++++ docs/auth0_universal-login_prompts.md | 33 +++++++++++++++++ ... => auth0_universal-login_prompts_show.md} | 14 +++---- ...> auth0_universal-login_prompts_update.md} | 14 +++---- ..._show.md => auth0_universal-login_show.md} | 8 ++-- ....md => auth0_universal-login_templates.md} | 10 ++--- ...> auth0_universal-login_templates_show.md} | 8 ++-- ...auth0_universal-login_templates_update.md} | 8 ++-- ...ate.md => auth0_universal-login_update.md} | 12 +++--- docs/index.md | 4 +- 24 files changed, 224 insertions(+), 192 deletions(-) delete mode 100644 docs/auth0_branding.md delete mode 100644 docs/auth0_branding_domains.md delete mode 100644 docs/auth0_branding_texts.md create mode 100644 docs/auth0_domains.md rename docs/{auth0_branding_domains_create.md => auth0_domains_create.md} (80%) rename docs/{auth0_branding_domains_delete.md => auth0_domains_delete.md} (69%) rename docs/{auth0_branding_domains_list.md => auth0_domains_list.md} (68%) rename docs/{auth0_branding_domains_show.md => auth0_domains_show.md} (68%) rename docs/{auth0_branding_domains_update.md => auth0_domains_update.md} (67%) rename docs/{auth0_branding_domains_verify.md => auth0_domains_verify.md} (68%) create mode 100644 docs/auth0_email.md rename docs/{auth0_branding_emails.md => auth0_email_templates.md} (68%) rename docs/{auth0_branding_emails_show.md => auth0_email_templates_show.md} (70%) rename docs/{auth0_branding_emails_update.md => auth0_email_templates_update.md} (81%) create mode 100644 docs/auth0_universal-login.md create mode 100644 docs/auth0_universal-login_prompts.md rename docs/{auth0_branding_texts_show.md => auth0_universal-login_prompts_show.md} (58%) rename docs/{auth0_branding_texts_update.md => auth0_universal-login_prompts_update.md} (57%) rename docs/{auth0_branding_show.md => auth0_universal-login_show.md} (74%) rename docs/{auth0_branding_templates.md => auth0_universal-login_templates.md} (72%) rename docs/{auth0_branding_templates_show.md => auth0_universal-login_templates_show.md} (68%) rename docs/{auth0_branding_templates_update.md => auth0_universal-login_templates_update.md} (67%) rename docs/{auth0_branding_update.md => auth0_universal-login_update.md} (71%) diff --git a/docs/auth0_branding.md b/docs/auth0_branding.md deleted file mode 100644 index 4ea304352..000000000 --- a/docs/auth0_branding.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default ---- -## auth0 branding - -Manage branding options - -### Synopsis - -Manage branding options. - -### Options - -``` - -h, --help help for branding -``` - -### Options inherited from parent commands - -``` - --debug Enable debug mode. - --json Output in json format. - --no-color Disable colors. - --no-input Disable interactivity. - --tenant string Specific tenant to use. -``` - -### SEE ALSO - -* [auth0](/auth0-cli/) - Supercharge your development workflow. -* [auth0 branding domains](auth0_branding_domains.md) - Manage custom domains -* [auth0 branding emails](auth0_branding_emails.md) - Manage custom email templates -* [auth0 branding show](auth0_branding_show.md) - Display the custom branding settings for Universal Login -* [auth0 branding templates](auth0_branding_templates.md) - Manage custom page templates -* [auth0 branding texts](auth0_branding_texts.md) - Manage custom text for prompts -* [auth0 branding update](auth0_branding_update.md) - Update the custom branding settings for Universal Login - diff --git a/docs/auth0_branding_domains.md b/docs/auth0_branding_domains.md deleted file mode 100644 index dd944b599..000000000 --- a/docs/auth0_branding_domains.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default ---- -## auth0 branding domains - -Manage custom domains - -### Synopsis - -Manage custom domains. - -### Options - -``` - -h, --help help for domains -``` - -### Options inherited from parent commands - -``` - --debug Enable debug mode. - --json Output in json format. - --no-color Disable colors. - --no-input Disable interactivity. - --tenant string Specific tenant to use. -``` - -### SEE ALSO - -* [auth0 branding](auth0_branding.md) - Manage branding options -* [auth0 branding domains create](auth0_branding_domains_create.md) - Create a custom domain -* [auth0 branding domains delete](auth0_branding_domains_delete.md) - Delete a custom domain -* [auth0 branding domains list](auth0_branding_domains_list.md) - List your custom domains -* [auth0 branding domains show](auth0_branding_domains_show.md) - Show a custom domain -* [auth0 branding domains update](auth0_branding_domains_update.md) - Update a custom domain -* [auth0 branding domains verify](auth0_branding_domains_verify.md) - Verify a custom domain - diff --git a/docs/auth0_branding_texts.md b/docs/auth0_branding_texts.md deleted file mode 100644 index 770ec7642..000000000 --- a/docs/auth0_branding_texts.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default ---- -## auth0 branding texts - -Manage custom text for prompts - -### Synopsis - -Manage custom text for prompts. - -### Options - -``` - -h, --help help for texts -``` - -### Options inherited from parent commands - -``` - --debug Enable debug mode. - --json Output in json format. - --no-color Disable colors. - --no-input Disable interactivity. - --tenant string Specific tenant to use. -``` - -### SEE ALSO - -* [auth0 branding](auth0_branding.md) - Manage branding options -* [auth0 branding texts show](auth0_branding_texts_show.md) - Show the custom texts for a prompt -* [auth0 branding texts update](auth0_branding_texts_update.md) - Update the custom texts for a prompt - diff --git a/docs/auth0_domains.md b/docs/auth0_domains.md new file mode 100644 index 000000000..591d7ea18 --- /dev/null +++ b/docs/auth0_domains.md @@ -0,0 +1,37 @@ +--- +layout: default +--- +## auth0 domains + +Manage custom domains + +### Synopsis + +Manage custom domains. + +### Options + +``` + -h, --help help for domains +``` + +### Options inherited from parent commands + +``` + --debug Enable debug mode. + --json Output in json format. + --no-color Disable colors. + --no-input Disable interactivity. + --tenant string Specific tenant to use. +``` + +### SEE ALSO + +* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0 domains create](auth0_domains_create.md) - Create a custom domain +* [auth0 domains delete](auth0_domains_delete.md) - Delete a custom domain +* [auth0 domains list](auth0_domains_list.md) - List your custom domains +* [auth0 domains show](auth0_domains_show.md) - Show a custom domain +* [auth0 domains update](auth0_domains_update.md) - Update a custom domain +* [auth0 domains verify](auth0_domains_verify.md) - Verify a custom domain + diff --git a/docs/auth0_branding_domains_create.md b/docs/auth0_domains_create.md similarity index 80% rename from docs/auth0_branding_domains_create.md rename to docs/auth0_domains_create.md index ce1c5e7ae..8637dec19 100644 --- a/docs/auth0_branding_domains_create.md +++ b/docs/auth0_domains_create.md @@ -1,7 +1,7 @@ --- layout: default --- -## auth0 branding domains create +## auth0 domains create Create a custom domain @@ -10,14 +10,14 @@ Create a custom domain Create a custom domain. ``` -auth0 branding domains create [flags] +auth0 domains create [flags] ``` ### Examples ``` -auth0 branding domains create -auth0 branding domains create +auth0 domains create +auth0 domains create ``` ### Options @@ -43,5 +43,5 @@ auth0 branding domains create ### SEE ALSO -* [auth0 branding domains](auth0_branding_domains.md) - Manage custom domains +* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_branding_domains_delete.md b/docs/auth0_domains_delete.md similarity index 69% rename from docs/auth0_branding_domains_delete.md rename to docs/auth0_domains_delete.md index f06e7f9c2..b4bbf21ca 100644 --- a/docs/auth0_branding_domains_delete.md +++ b/docs/auth0_domains_delete.md @@ -1,7 +1,7 @@ --- layout: default --- -## auth0 branding domains delete +## auth0 domains delete Delete a custom domain @@ -10,14 +10,14 @@ Delete a custom domain Delete a custom domain. ``` -auth0 branding domains delete [flags] +auth0 domains delete [flags] ``` ### Examples ``` -auth0 branding domains delete -auth0 branding domains delete +auth0 domains delete +auth0 domains delete ``` ### Options @@ -39,5 +39,5 @@ auth0 branding domains delete ### SEE ALSO -* [auth0 branding domains](auth0_branding_domains.md) - Manage custom domains +* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_branding_domains_list.md b/docs/auth0_domains_list.md similarity index 68% rename from docs/auth0_branding_domains_list.md rename to docs/auth0_domains_list.md index 5a56ee141..d9fa0c8ab 100644 --- a/docs/auth0_branding_domains_list.md +++ b/docs/auth0_domains_list.md @@ -1,24 +1,24 @@ --- layout: default --- -## auth0 branding domains list +## auth0 domains list List your custom domains ### Synopsis List your existing custom domains. To create one try: -auth0 branding domains create +auth0 domains create ``` -auth0 branding domains list [flags] +auth0 domains list [flags] ``` ### Examples ``` -auth0 branding domains list -auth0 branding domains ls +auth0 domains list +auth0 domains ls ``` ### Options @@ -39,5 +39,5 @@ auth0 branding domains ls ### SEE ALSO -* [auth0 branding domains](auth0_branding_domains.md) - Manage custom domains +* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_branding_domains_show.md b/docs/auth0_domains_show.md similarity index 68% rename from docs/auth0_branding_domains_show.md rename to docs/auth0_domains_show.md index a034d1834..826a52ae6 100644 --- a/docs/auth0_branding_domains_show.md +++ b/docs/auth0_domains_show.md @@ -1,7 +1,7 @@ --- layout: default --- -## auth0 branding domains show +## auth0 domains show Show a custom domain @@ -10,14 +10,14 @@ Show a custom domain Show a custom domain. ``` -auth0 branding domains show [flags] +auth0 domains show [flags] ``` ### Examples ``` -auth0 branding domains show -auth0 branding domains show +auth0 domains show +auth0 domains show ``` ### Options @@ -38,5 +38,5 @@ auth0 branding domains show ### SEE ALSO -* [auth0 branding domains](auth0_branding_domains.md) - Manage custom domains +* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_branding_domains_update.md b/docs/auth0_domains_update.md similarity index 67% rename from docs/auth0_branding_domains_update.md rename to docs/auth0_domains_update.md index 9f530b134..fd240ef37 100644 --- a/docs/auth0_branding_domains_update.md +++ b/docs/auth0_domains_update.md @@ -1,7 +1,7 @@ --- layout: default --- -## auth0 branding domains update +## auth0 domains update Update a custom domain @@ -10,15 +10,15 @@ Update a custom domain Update a custom domain. ``` -auth0 branding domains update [flags] +auth0 domains update [flags] ``` ### Examples ``` -auth0 branding domains update -auth0 branding domains update --policy compatible -auth0 branding domains update -p compatible --ip-header "cf-connecting-ip" +auth0 domains update +auth0 domains update --policy compatible +auth0 domains update -p compatible --ip-header "cf-connecting-ip" ``` ### Options @@ -41,5 +41,5 @@ auth0 branding domains update -p compatible --ip-header "cf-connecting-ip" ### SEE ALSO -* [auth0 branding domains](auth0_branding_domains.md) - Manage custom domains +* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_branding_domains_verify.md b/docs/auth0_domains_verify.md similarity index 68% rename from docs/auth0_branding_domains_verify.md rename to docs/auth0_domains_verify.md index f4b2d7609..a7d0faf6a 100644 --- a/docs/auth0_branding_domains_verify.md +++ b/docs/auth0_domains_verify.md @@ -1,7 +1,7 @@ --- layout: default --- -## auth0 branding domains verify +## auth0 domains verify Verify a custom domain @@ -10,14 +10,14 @@ Verify a custom domain Verify a custom domain. ``` -auth0 branding domains verify [flags] +auth0 domains verify [flags] ``` ### Examples ``` -auth0 branding domains verify -auth0 branding domains verify +auth0 domains verify +auth0 domains verify ``` ### Options @@ -38,5 +38,5 @@ auth0 branding domains verify ### SEE ALSO -* [auth0 branding domains](auth0_branding_domains.md) - Manage custom domains +* [auth0 domains](auth0_domains.md) - Manage custom domains diff --git a/docs/auth0_email.md b/docs/auth0_email.md new file mode 100644 index 000000000..ee0ffcf53 --- /dev/null +++ b/docs/auth0_email.md @@ -0,0 +1,32 @@ +--- +layout: default +--- +## auth0 email + +Manage email settings + +### Synopsis + +Manage email settings. + +### Options + +``` + -h, --help help for email +``` + +### Options inherited from parent commands + +``` + --debug Enable debug mode. + --json Output in json format. + --no-color Disable colors. + --no-input Disable interactivity. + --tenant string Specific tenant to use. +``` + +### SEE ALSO + +* [auth0](/auth0-cli/) - Supercharge your development workflow. +* [auth0 email templates](auth0_email_templates.md) - Manage custom email templates + diff --git a/docs/auth0_branding_emails.md b/docs/auth0_email_templates.md similarity index 68% rename from docs/auth0_branding_emails.md rename to docs/auth0_email_templates.md index 54c7da65e..839afc707 100644 --- a/docs/auth0_branding_emails.md +++ b/docs/auth0_email_templates.md @@ -1,7 +1,7 @@ --- layout: default --- -## auth0 branding emails +## auth0 email templates Manage custom email templates @@ -12,7 +12,7 @@ Manage custom email templates. This requires a custom email provider to be confi ### Options ``` - -h, --help help for emails + -h, --help help for templates ``` ### Options inherited from parent commands @@ -27,7 +27,7 @@ Manage custom email templates. This requires a custom email provider to be confi ### SEE ALSO -* [auth0 branding](auth0_branding.md) - Manage branding options -* [auth0 branding emails show](auth0_branding_emails_show.md) - Show an email template -* [auth0 branding emails update](auth0_branding_emails_update.md) - Update an email template +* [auth0 email](auth0_email.md) - Manage email settings +* [auth0 email templates show](auth0_email_templates_show.md) - Show an email template +* [auth0 email templates update](auth0_email_templates_update.md) - Update an email template diff --git a/docs/auth0_branding_emails_show.md b/docs/auth0_email_templates_show.md similarity index 70% rename from docs/auth0_branding_emails_show.md rename to docs/auth0_email_templates_show.md index c0384dcad..3c8f6698d 100644 --- a/docs/auth0_branding_emails_show.md +++ b/docs/auth0_email_templates_show.md @@ -1,7 +1,7 @@ --- layout: default --- -## auth0 branding emails show +## auth0 email templates show Show an email template @@ -10,14 +10,14 @@ Show an email template Show an email template. ``` -auth0 branding emails show [flags] +auth0 email templates show [flags] ``` ### Examples ``` -auth0 branding emails show