Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Use our "[Self review checklist](https://docs.github.com/en/contributing/collabo
- [Link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if applicable
- Enable [maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)

A Docs team member will review following our [standard review process](https://docs.github.com/en/contributing).
A Technical Content team member will review following our [standard review process](https://docs.github.com/en/contributing).

### Your PR is merged!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ redirect_from:
- /admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/best-practices-for-structuring-organizations-in-your-enterprise
- /admin/concepts/best-practices-for-enterprises
- /admin/concepts/best-practices
- /enterprise-onboarding/setting-up-organizations-and-teams/best-practices-for-organizations-in-your-enterprise
- /enterprise-onboarding/setting-up-organizations-and-teams/best-practices-for-organizations-in-your-enterprise
- /enterprise-onboarding/setting-up-organizations-and-teams/best-practices
allowTitleToDifferFromFilename: true
category:
Expand Down Expand Up @@ -60,11 +60,3 @@ We recommend collaborating in organization-owned repositories whenever possible
Innersource makes it easy for all employees to discover and reuse work. This allows development teams to learn from each other and avoid duplicating effort to recreate common services.

For guidance on setting up effective innersource practices, see [AUTOTITLE](/admin/concepts/enterprise-best-practices/use-innersource).

{% ifversion ghec %}

## Next steps

Learn how to set up your enterprise according to best practices in our [AUTOTITLE](/enterprise-cloud@latest/enterprise-onboarding) journey for {% data variables.product.prodname_ghe_cloud %}.

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,3 @@ Specifically, you may want to hide internal repositories from an external collab
Outside collaborators (called **repository collaborators** if you use {% data variables.product.prodname_emus %}) only have access to a specific repository. These users are not full organization members, so they do not receive the base level of access for the organization, and they cannot automatically see internal repositories in the enterprise unless they are a member of another organization.

For more information, see {% ifversion ghec %}[AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/enabling-guest-collaborators) and{% endif %} [AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/managing-outside-collaborators/adding-outside-collaborators-to-repositories-in-your-organization).

## Next steps

Now that you've set up organizations and teams, learn how to stay compliant and secure by setting up governance policies for your users and repositories. See [AUTOTITLE](/admin/concepts/security-and-compliance/enterprise-policies).
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,3 @@ Use **{% data variables.product.prodname_github_apps %} and {% data variables.pr
* A {% data variables.product.prodname_github_app %} needs to trigger a workflow
* External logic orchestrates in-repo execution
* Enterprise-wide policies or workflows require both identity and runtime

## Next steps

Learn how to design and manage {% data variables.product.prodname_github_apps %} at the enterprise level in [AUTOTITLE](/admin/managing-github-apps-for-your-enterprise/creating-github-apps-for-your-enterprise).
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,3 @@ For a managed user to collaborate outside your enterprise, they must also mainta
If you already have an enterprise that uses personal accounts on {% data variables.product.prodname_dotcom_the_website %}, adoption of {% data variables.product.prodname_emus %} requires **migration to a new enterprise account**. To discuss this process, contact [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact).

The migration process may require time or cost from your team. Confirm that this migration process is acceptable to your business and your users. If not, an enterprise with personal accounts may be the better choice.

## Next steps

When you have chosen an enterprise type, you're ready to create an enterprise account by starting a trial. See [AUTOTITLE](/admin/overview/setting-up-a-trial-of-github-enterprise-cloud).
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,3 @@ To follow the principle of least privilege access, we recommend using custom rol
Enterprise owners can create custom enterprise roles and assign enterprise roles to users and teams. They can also create custom organization roles to be used across organizations, but these roles can only be assigned by organization owners.

Organization owners can grant organization roles and create custom organization roles, but cannot edit roles or change role assignments that are defined at the enterprise level.

## Next steps

Now that you understand roles, plan which roles will be required for your teams to do their jobs on {% data variables.product.github %}. See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/identify-role-requirements).
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,3 @@ However, unlike organization teams, enterprise teams currently do **not** suppor
{% data reusables.enterprise.enterprise-teams-limits %}

For more information about the capabilities of organization teams, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams).

## Next steps

If your needs are covered by enterprise teams, create a team. See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/create-enterprise-teams).

If you need to create an organization team, an organization owner must do this from the organization settings. See [AUTOTITLE](/organizations/organizing-members-into-teams/creating-a-team).
55 changes: 55 additions & 0 deletions content/admin/enterprise-onboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: Enterprise onboarding
intro: Onboard your company to {% data variables.product.prodname_ghe_cloud %} by following our recommended plan. You will set up teams with the access they need, create a policy framework to ensure compliance, and automate processes securely throughout your enterprise.
layout: journey-landing
journeyTracks:
- id: getting_started
title: Getting started with your enterprise
description: Master the fundamentals of {% data variables.product.prodname_ghe_cloud %} and get started with a trial.
guides:
- href: /admin/concepts/enterprise-fundamentals/choose-an-enterprise-type
- href: /admin/overview/setting-up-a-trial-of-github-enterprise-cloud
- href: /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/add-users
- href: /billing/concepts/enterprise-billing/billing-for-enterprises
- href: /migrations/overview/planning-your-migration-to-github
- id: setting_up_organizations_and_teams
title: Setting up organizations and teams in your enterprise
description: Organize work effectively and ensure people have the access they need to resources and administrative settings.
guides:
- href: /admin/concepts/enterprise-best-practices/organize-work
- href: /admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise
- href: /admin/concepts/enterprise-fundamentals/roles-in-an-enterprise
- href: /admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/identify-role-requirements
- href: /admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/create-custom-roles
- href: /admin/concepts/enterprise-fundamentals/teams-in-an-enterprise
- href: /admin/managing-accounts-and-repositories/managing-users-in-your-enterprise/create-enterprise-teams
- href: /admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/assign-roles
- href: /admin/concepts/enterprise-best-practices/use-innersource
- id: govern_people_and_repositories
title: Governing people and repositories
description: Implement policies, custom properties, and rulesets to govern users and repositories across your enterprise.
guides:
- href: /admin/concepts/security-and-compliance/enterprise-policies
- href: /admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/managing-custom-properties-for-repositories-in-your-enterprise
- href: /admin/managing-accounts-and-repositories/managing-repositories-in-your-enterprise/governing-how-people-use-repositories-in-your-enterprise
- href: /admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance
- href: /admin/concepts/security-and-compliance/audit-log-for-an-enterprise
- id: github_apps
title: Automating processes with GitHub Apps
description: Create and install apps to automate processes securely in your enterprise and organizations.
guides:
- href: /admin/concepts/enterprise-fundamentals/automations-in-your-enterprise
- href: /admin/managing-github-apps-for-your-enterprise/creating-github-apps-for-your-enterprise
- href: /apps/using-github-apps/installing-a-github-app-on-your-enterprise
versions:
ghec: '*'
redirect_from:
- /enterprise-onboarding/feature-enhancements
- /enterprise-onboarding/getting-started-with-your-enterprise
- /enterprise-onboarding/govern-people-and-repositories
- /enterprise-onboarding
docsTeamMetrics:
- enterprise-onboarding
contentType: other
---

1 change: 1 addition & 0 deletions content/admin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ versions:
ghec: '*'
ghes: '*'
children:
- /enterprise-onboarding
- /overview
- /concepts
- /data-residency
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,3 @@ Enterprise owners can create and edit custom organization roles, but cannot assi
1. In the left sidebar, select **Organization roles**.
1. Click **Create custom role**.
1. Enter the details, then click **Create role**.

{% ifversion enterprise-teams %}

## Next steps

You can manage role assignments at scale using teams. Learn about teams in your enterprise and organizations in [AUTOTITLE](/admin/concepts/enterprise-fundamentals/teams-in-an-enterprise).

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,3 @@ Another way to delegate frequent, time-consuming tasks is to assign work to {% d
For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents).

{% endif %}

## Next steps

Now that you've planned which roles will help your teams be productive and secure on GitHub, create custom roles for the permissions you need. Later, you will create teams to manage role assignments at scale. See [AUTOTITLE](/admin/managing-accounts-and-repositories/managing-roles-in-your-enterprise/create-custom-roles).
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,12 @@ You'll **need help** creating an enterprise account if you require:
* {% data variables.product.prodname_ghe_server %}
* {% data variables.enterprise.data_residency %}
* Invoicing
* A dedicated enterprise for managing {% data variables.copilot.copilot_for_business %} licenses without adopting {% data variables.product.prodname_enterprise %}

In these cases, contact {% data variables.contact.contact_enterprise_sales %}.

> [!NOTE]
> {% data variables.product.company_short %} no longer provisions separate "dedicated" enterprise accounts for managing {% data variables.copilot.copilot_for_business %} licenses without adopting {% data variables.product.prodname_enterprise %}. In any enterprise account, you can assign {% data variables.copilot.copilot_for_business %} licenses directly to members who don't belong to an organization, and those members don't consume a {% data variables.product.prodname_enterprise %} license. See [AUTOTITLE](/copilot/how-tos/copilot-on-github/set-up-copilot/enable-copilot/set-up-a-dedicated-enterprise-for-copilot-business).

## What will happen after I upgrade my organization?

The following changes also apply to single organizations that are automatically upgraded to an enterprise account. For details, see [{% data variables.product.prodname_blog %}](https://github.blog/changelog/2024-06-19-upcoming-automatic-upgrade-to-the-enterprise-account-experience/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ The trial lasts for **{% data reusables.enterprise.ghec-trial-length %} days** a
* {% data variables.product.prodname_GH_cs_and_sp %} ({% data variables.product.prodname_dotcom_the_website %} trials only)
* Up to 3,000 minutes of standard {% data variables.product.prodname_dotcom %}-hosted runners.

The 50,000 monthly {% data variables.product.prodname_actions %} minutes included with a paid {% data variables.product.prodname_ghe_cloud %} plan do not apply during the trial. The trial includes up to 3,000 minutes of standard {% data variables.product.prodname_dotcom %}-hosted runners. If your trial uses {% data variables.product.prodname_emus %}, you must link an Azure subscription to exceed this limit. If your trial doesn't use {% data variables.product.prodname_emus %}, linking an Azure subscription immediately ends the trial and begins paid usage. For more information, see [AUTOTITLE](/billing/reference/azure-subscription).

Usage of available AI-powered features consumes {% data variables.product.prodname_ai_credits_short %}. For more information, see [AUTOTITLE](/copilot/concepts/billing/usage-based-billing-for-organizations-and-enterprises).

## Features not included in the trial

* {% data variables.product.prodname_github_codespaces %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,18 @@ To set up a trial of {% data variables.product.prodname_GHAS %} using this metho

During a trial of {% data variables.product.prodname_GHAS %}, you can add any number of committers and enable {% data variables.product.prodname_GH_cs_and_sp %} for any number of organizations.

## Billing during your trial

During the trial, you do not pay license fees for {% data variables.product.prodname_GHAS %}.

{% ifversion fpt or ghec %}

Usage-based billing continues for features that consume {% data variables.product.prodname_actions %} minutes or {% data variables.product.prodname_ai_credits_short %}.

For private repositories, minutes used by {% data variables.product.prodname_GHAS %} workflows that run on standard {% data variables.product.prodname_dotcom %}-hosted runners, including code scanning workflows, count toward the 50,000 minutes included each month with your {% data variables.product.prodname_ghe_cloud %} plan. Workflows in public repositories or on self-hosted runners do not consume included minutes. {% data variables.actions.hosted_runners %} are billed separately. Usage beyond the included amount is billed at the standard rate. For more information, see [AUTOTITLE](/billing/reference/product-usage-included).

{% endif %}

## Finishing your trial

You can finish your trial at any time by purchasing licenses for {% data variables.product.prodname_GH_cs_or_sp %}. If you haven't made a purchase by the end of the 30 days, your trial will expire.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ category:

## Using the TODOCS placeholder

Sometimes technical writers use placeholders while writing documentation to remind themselves to come back to something later. It's a useful technique, but there's always the possibility that the placeholder will be overlooked and slip into production. At that point, the only way the Docs team will find out about it is if someone sees it and reports it.
Sometimes technical writers use placeholders while writing documentation to remind themselves to come back to something later. It's a useful technique, but there's always the possibility that the placeholder will be overlooked and slip into production. At that point, the only way the Technical Content team will find out about it is if someone sees it and reports it.

To prevent slips, use the string `TODOCS` as your placeholder. The Docs test suite includes a [linting test](https://github.com/github/docs/tree/main/src/content-linter) that will fail if it finds this string anywhere in a Markdown or YAML file.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ If a diagram is only relevant to some versions and apt to become quickly out of

Diagrams are stored in the relevant directory in the `assets/images/help/` directory in the `docs` repository. If you are creating a new diagram, add it to the proper folder. If you are updating an existing diagram, replace the existing diagram with the updated version.

When you create a new diagram, add it to the Diagrams project in the Docs Figma team or provide a copy of the Figma file to a member of the Docs team. If you create a diagram in another program, it can be included in {% data variables.product.prodname_docs %} if it meets the requirements and recommendations in this guide, but it is much more likely to be removed rather than updated if it becomes out of date.
When you create a new diagram, add it to the Diagrams project in the Docs Figma team or provide a copy of the Figma file to a member of the Technical Content team. If you create a diagram in another program, it can be included in {% data variables.product.prodname_docs %} if it meets the requirements and recommendations in this guide, but it is much more likely to be removed rather than updated if it becomes out of date.

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Follow guidance in [AUTOTITLE](/contributing/writing-for-github-docs/best-practi

Incorporate keywords, or top search terms used by your audience, into page copy and metadata. For example, if you are writing about "billing" but your audience primarily uses "cost" and "payment," use those terms instead.

Google and Bing both offer keyword research tools to help you discover relevant keywords. The Docs team also consults Google Search Console data to understand what search terms lead to pages on {% data variables.product.prodname_docs %}.
Google and Bing both offer keyword research tools to help you discover relevant keywords. The Technical Content team also consults Google Search Console data to understand what search terms lead to pages on {% data variables.product.prodname_docs %}.

### Include metadata

Expand Down
Loading
Loading