Skip to content

Commit

Permalink
DXCDT-390: Update to latest just-the-docs, add warning callout (#653)
Browse files Browse the repository at this point in the history
Co-authored-by: Sergiu Ghitea <[email protected]>
  • Loading branch information
ewanharris and sergiught authored Mar 3, 2023
1 parent b2d63db commit 72d66be
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
6 changes: 5 additions & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,15 @@ github_username: auth0
github_repo: auth0-cli

# Build settings
remote_theme: just-the-docs/[email protected].0.rc3
remote_theme: just-the-docs/[email protected].1

search_enabled: true
favicon_ico: "/assets/images/favicon.png"

aux_links:
"Auth0 CLI on GitHub":
- "//github.com/auth0/auth0-cli"

callouts:
warning:
color: yellow
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ There are two ways to authenticate:
- **As a user** - Recommended when invoking on a personal machine or other interactive environment. Facilitated by [device authorization](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow) flow.
- **As a machine** - Recommended when running on a server or non-interactive environments (ex: CI). Facilitated by [client credentials](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) flow. Flags available for bypassing interactive shell.

> ⚠️ Authenticating as a user is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials.
{: .warning }
Authenticating as a user is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials.

## Available Commands

Expand Down
3 changes: 2 additions & 1 deletion internal/cli/doc-gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ There are two ways to authenticate:
- **As a user** - Recommended when invoking on a personal machine or other interactive environment. Facilitated by [device authorization](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow) flow.
- **As a machine** - Recommended when running on a server or non-interactive environments (ex: CI). Facilitated by [client credentials](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) flow. Flags available for bypassing interactive shell.
> ⚠️ Authenticating as a user is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials.
{: .warning }
Authenticating as a user is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials.
## Available Commands
Expand Down

0 comments on commit 72d66be

Please sign in to comment.