Skip to content

Commit 9859026

Browse files
authored
Merge pull request #17008 from github/repo-sync
repo sync
2 parents a18e4e7 + 8a15c9b commit 9859026

File tree

1 file changed

+51
-3
lines changed

1 file changed

+51
-3
lines changed

contributing/content-style-guide.md

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -540,12 +540,60 @@ Do not use symbols or octicons that aren’t used in GitHub’s user interface.
540540
541541
### Accounts
542542
543-
To avoid ambiguity and confusion, do not use product names as adjectives to describe accounts in any of our products. Instead, clarify the account type and choose clearer phrasing that avoids conflating accounts and products. When talking about accounts, only refer to the product name when needed to disambiguate between products.
544-
- **Use:** Your organization account
545-
- **Use:** Your user account on GitHub Enterprise Cloud
543+
#### Product names and accounts
544+
545+
To avoid ambiguity and confusion, do not use product names as adjectives to describe accounts in any of our products. Instead, clarify the account type and choose clearer phrasing that avoids conflating accounts and products. When talking about accounts, only refer to the product name when needed to disambiguate between products. For more information about types of accounts available in GitHub's products, see "[Types of GitHub accounts](https://docs.github.com/en/get-started/learning-about-github/types-of-github-accounts)."
546+
- **Use:** Your organization on GitHub Enterprise Cloud
547+
- **Avoid:** Your GitHub Enterprise Cloud account
546548
- **Avoid:** Your GitHub Enterprise Server organization
547549
- **Use:** You can highlight your work on GitHub Enterprise Server by sending the contribution counts to your GitHub.com profile.
548550
551+
#### Individual people's accounts on GitHub
552+
553+
We refer to an account that an individual person signs into in various ways depending on the context.
554+
555+
Unless the content is about administering an enterprise product, describe an individual person's account on GitHub as a "personal account." This creates consistency with the UI and prevents readers from being confused by seeing two terms that mean the same thing.
556+
557+
- **Use:** Managing scheduled reminders for your personal account
558+
- **Avoid:** Managing scheduled reminders for your user account
559+
560+
#### Accounts for enterprise products
561+
562+
With GitHub's enterprise products, administrators manage an enterprise account. An enterprise account can own multiple organizations, and people's user accounts can be members of the organizations. For more information, see the "Roles in an enterprise" article for each product.
563+
564+
- [GitHub Enterprise Cloud](https://docs.github.com/en/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)
565+
- [GitHub Enterprise Server](https://docs.github.com/en/enterprise-server/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)
566+
- [GitHub AE](https://docs.github.com/en/github-ae@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)
567+
568+
If the reader manages an enterprise account, and you're describing the people's accounts that they manage, use "user account." This applies to the following products.
569+
570+
- GitHub Enterprise Cloud with Enterprise Managed Users
571+
- **Use:** With Enterprise Managed Users, you can create and manage user accounts for your enterprise members.
572+
- **Avoid:** With Enterprise Managed Users, you can create and manage the personal accounts for your enterprise members.
573+
- GitHub Enterprise Server
574+
- **Use:** If you need to temporarily take over a user account...
575+
- **Avoid:** If you need to temporarily take over a personal account...
576+
- GitHub AE
577+
- **Use:** Authorized users can access your enterprise from any IP address.
578+
- **Avoid:** Authorized personal accounts can access your enterprise from any IP address.
579+
580+
The following documentation should reference "user accounts."
581+
582+
- The "[Enterprise administrators](https://docs.github.com/en/enterprise-cloud@latest/admin)" product
583+
- Enterprise-specific billing documentation, like "[About billing for your enterprise](https://docs.github.com/en/enterprise-cloud@latest/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise)"
584+
- Content within other products that's intended for an administrative audience, like "[Best practices for securing accounts](https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/end-to-end-supply-chain/securing-accounts)" in the "Code security" product or "[Setting up a trial of GitHub Enterprise Cloud](https://docs.github.com/en/enterprise-cloud@latest/get-started/signing-up-for-github/setting-up-a-trial-of-github-enterprise-cloud)" in the "Get started" product
585+
- Enterprise-specific API content, like the "[GitHub Enterprise administration](https://docs.github.com/en/enterprise-cloud@latest/rest/reference/enterprise-admin)" REST API reference documentation
586+
587+
For enterprises on GitHub Enterprise Cloud that don't use Enterprise Managed Users, use "personal account" when describing members of organizations owned by the enterprise.
588+
589+
- **Use:** If you configure SAML SSO, members of your organization will continue to log into their personal accounts on GitHub.com.
590+
- **Avoid:** If you configure SAML SSO, members of your organization will continue to log into their user accounts on GitHub.com.
591+
592+
Documentation that describes GitHub Enterprise Cloud without Enterprise Managed Users is generally in the "[Managing SAML single sign-on for your organization](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization)" category.
593+
594+
#### People's accounts for other services
595+
596+
When you describe a person's account for a service other than GitHub, such as an integration or authentication provider, use "user account."
549597
### Acronyms
550598
551599
Spell out acronyms the first time they’re used in an article, except in titles or headers.

0 commit comments

Comments
 (0)