Skip to content

Latest commit

 

History

History
49 lines (32 loc) · 2.01 KB

WORDS.md

File metadata and controls

49 lines (32 loc) · 2.01 KB

Words

This document contains spellings and definitions as they are to be used in the Auth0 docs.

  • Login / Log in: Use log in as a verb, or login as a noun. Do NOT use log into or login to.
  • Logout / Log out: Use log out as a verb, or logout as a noun.
  • Setup / Set up: Use set up as a verb, or setup as a noun.
  • Multi-factor: Use multi-factor instead of multifactor in the case of multi-factor authentication.
  • Rollout / Roll out: Use rollout as a noun and roll out as a verb. Do not use roll-out.
  • Email: Use the un-hyphenated "email" to refer to an email address.
  • Click: Use "Click on" when referring to text links in a webpage or UI, "Click" when referring to a button. For example: Click Save. Click on This link.
  • Website: Use "website", NOT "web site".
  • i.e.: I.e. means in other words. Use that is, instead.
  • e.g.: E.g. means for example. Use for example, instead.
  • etc.: Use it when the space is too limited for the alternative. Otherwise use and so on.
  • a vs an: Where the 'u' sounds like 'you' we use 'a' (for example, a university vs an umbrella)

Dashboard-Related Terminology

Account

Represents a user, their credentials, and (optionally) a profile and other attributes

Subscription

Defines custom terms; this is a contract or service plan e.g. trial, free, developer or developer-pro

Tenant

A logical isolation unit of the products we offer. e.g. a tenant of Auth0 would be foo.auth0.com vs. another tenant bar.auth0.com.

Tokens

When writing about tokens, capitalize specific token names as follows:

  • ID Token
  • Access Token
  • Refresh Token

Within Appliance subscriptions

  • Auth0 tenants refers to regular cloud tenants
  • Private instances refers to appliance instances

TL;DR

Generally speaking, unless you're referring to MFA configuration, payment options, or user profiles (for the owner of the account), you'll use tenant, not account.