jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Change the order

Browse Source
This commit is contained in:
Sophie
2022-04-07 17:37:30 +02:00
parent 276faebe74
commit 80c32c9abb
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
contributing/content-style-guide.md
View File

@@ -550,13 +550,6 @@ When referring to a user account that a person creates and manages on GitHub.com
In administrative content for GitHub Enterprise Cloud with Enterprise Managed Users, GitHub Enterprise Server, or GitHub AE, use "user account." For GitHub Enterprise Cloud and GitHub AE, you can also use "enterprise member" when describing an individual user account that is an enterprise administrator or that contributes to an organization owned by an enterprise.
Examples of administrative content:
1. The "[Enterprise administrators](https://docs.github.com/en/enterprise-cloud@latest/admin)" product should generally not mention "personal accounts" unless we're describing GitHub Enterprise Cloud without Enterprise Managed Users
2. 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)"
3. Other content with 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 "[Signing up for GitHub](https://docs.github.com/en/enterprise-cloud@latest/get-started/signing-up-for-github)" in the "Get started" product
4. Organization-level GitHub Enterprise Cloud features, like 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)" and "[Granting access to your organization with SAML single sign-on](https://docs.github.com/en/enterprise-cloud@latest/organizations/granting-access-to-your-organization-with-saml-single-sign-on)" categories
5. Enterprise-specific API documentation, like the "[GitHub Enterprise administration](https://docs.github.com/en/enterprise-cloud@latest/rest/reference/enterprise-admin)" REST API reference documentation
Examples for each product:
- GitHub.com (Free or Pro plans)
@@ -575,6 +568,13 @@ Examples for each product:
- **Use:** Authorized users can access your enterprise from any IP address.
- **Avoid:** Authorized personal accounts can access your enterprise from any IP address.
Examples of administrative content:
1. The "[Enterprise administrators](https://docs.github.com/en/enterprise-cloud@latest/admin)" product should generally not mention "personal accounts" unless we're describing GitHub Enterprise Cloud without Enterprise Managed Users
2. 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)"
3. Other content with 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 "[Signing up for GitHub](https://docs.github.com/en/enterprise-cloud@latest/get-started/signing-up-for-github)" in the "Get started" product
4. Organization-level GitHub Enterprise Cloud features, like 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)" and "[Granting access to your organization with SAML single sign-on](https://docs.github.com/en/enterprise-cloud@latest/organizations/granting-access-to-your-organization-with-saml-single-sign-on)" categories
5. Enterprise-specific API documentation, like the "[GitHub Enterprise administration](https://docs.github.com/en/enterprise-cloud@latest/rest/reference/enterprise-admin)" REST API reference documentation
### Acronyms
Spell out acronyms the first time they’re used in an article, except in titles or headers.