diff --git a/docs/enterprise-cloud/github-enterprise-cloud.md b/docs/enterprise-cloud/github-enterprise-cloud.md new file mode 100644 index 0000000000..c4a06558ac --- /dev/null +++ b/docs/enterprise-cloud/github-enterprise-cloud.md @@ -0,0 +1,68 @@ +# GitHub Enterprise Cloud + +Use your GitHub Enterprise credentials when signup or login to Codacy and all your GitHub Enterprise organizations that you belong to, will be available to be added as Organizations on Codacy. + +Codacy also has a dedicated Enterprise area where GitHub Enterprise admins and owners of the enterprise will be able to manage them. + +### GitHub Enterprise types +Codacy supports both [GitHub Enterprises types](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/understanding-iam-for-enterprises/choosing-an-enterprise-type-for-github-enterprise-cloud), Managed Users and Personal Accounts. + +## Access cloud Enterprises +Access you enterprises in Codacy by setting up its integration: +1. In codacy app, click on your avatar image, in the top right corner +2. then navigate throught "My account" and "Access management" +3. There, you'll be able to add a **GitHub Enterprise Cloud** access token. + +Once generated and added in Codacy you will start seeing all infomration you have access to regarding your cloud enterprises. +You can revoke the cloud enterpises access at any time in the same place. +![Enterprise cloud manage enterprises access](images/Codacy-Access-Management.png) + + +## Manage Enterprises +- [Enterprise organizations list](#enterprise-organizations-list) +- [Seats management](#seats) +- [Enterprise Limitations](#limitations) + +Once signup or login with your GitHub Enterprise credentials and, [setup access to could enterprises](#access-cloud-enterprises), navigate to your Enterprises area to manage your enterprises in Codacy, as well its organizations and seats management. + +!!! note If you only have one Enterprise, Codacy will skip this screen and directs you to the [enterprise organizations list](#enterprise-organizations-list). + +![Enterprise cloud manage enterprises](images/Codacy-Enterprises.png) + +### Enterprise organizations list +Choose to view a enterprise and access its list of existing organizations, that you have access to. +![Enterprise cloud manage organizations](images/Codacy-Enterprise-Organizations.png) + +### Seats +View and export your enterprise seats and its activity by: +1. Choose and view an enterprise organization +2. Navigate to **People** on the left-handside navigation +3. View, search and export the list of author seats +!!! note Codacy members will not be part of this list, only authors, users that have dome commits. + +### Limitations +Currently, the integration between Codacy and GitHub Enterprise has the following limitations: + +- **Repositories with visibility Internal** will, in Codacy, have the same behavior as Private visibility. Although you see the repository in the provider, if you aren't part of the repository in the provider, you won't be able to see it in Codacy. +- **Same email connected to multiple GitHub accounts.** Codacy won't allow you to connect your enterprise account if that email is already associated with a different GitHub account. You can manage your [associated emails in the provider GitHub](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). + + + +## See also + +- [How does Codacy support GitLab Cloud?](../faq/general/how-does-codacy-support-gitlab-cloud.md) +- [How does Codacy support GitLab Enterprise?](../faq/general/how-does-codacy-support-gitlab-enterprise.md) +- [How does Codacy support Bitbucket Cloud?](../faq/general/how-does-codacy-support-bitbucket-cloud.md) +- [How does Codacy support Bitbucket Server?](../faq/general/how-does-codacy-support-bitbucket-server.md) + +

+*** +#### Check out what's new, and to come, in Codacy +
+ +
diff --git a/docs/enterprise-cloud/images/Access enterprises.png b/docs/enterprise-cloud/images/Access enterprises.png new file mode 100644 index 0000000000..724fbe1cbe Binary files /dev/null and b/docs/enterprise-cloud/images/Access enterprises.png differ diff --git a/docs/enterprise-cloud/images/Access managmeent access.png b/docs/enterprise-cloud/images/Access managmeent access.png new file mode 100644 index 0000000000..fff125ed19 Binary files /dev/null and b/docs/enterprise-cloud/images/Access managmeent access.png differ diff --git a/docs/enterprise-cloud/images/Codacy-Access-Management-revoke-approval.png b/docs/enterprise-cloud/images/Codacy-Access-Management-revoke-approval.png new file mode 100644 index 0000000000..c591efec49 Binary files /dev/null and b/docs/enterprise-cloud/images/Codacy-Access-Management-revoke-approval.png differ diff --git a/docs/enterprise-cloud/images/Codacy-Access-Management-revoke.png b/docs/enterprise-cloud/images/Codacy-Access-Management-revoke.png new file mode 100644 index 0000000000..aad8586520 Binary files /dev/null and b/docs/enterprise-cloud/images/Codacy-Access-Management-revoke.png differ diff --git a/docs/enterprise-cloud/images/Codacy-Access-Management.png b/docs/enterprise-cloud/images/Codacy-Access-Management.png new file mode 100644 index 0000000000..d1f0601114 Binary files /dev/null and b/docs/enterprise-cloud/images/Codacy-Access-Management.png differ diff --git a/docs/enterprise-cloud/images/Codacy-Enterprise-Organizations.png b/docs/enterprise-cloud/images/Codacy-Enterprise-Organizations.png new file mode 100644 index 0000000000..f663e2e04e Binary files /dev/null and b/docs/enterprise-cloud/images/Codacy-Enterprise-Organizations.png differ diff --git a/docs/enterprise-cloud/images/Codacy-Enterprise-Seats.png b/docs/enterprise-cloud/images/Codacy-Enterprise-Seats.png new file mode 100644 index 0000000000..5949aeaf4e Binary files /dev/null and b/docs/enterprise-cloud/images/Codacy-Enterprise-Seats.png differ diff --git a/docs/enterprise-cloud/images/Codacy-Enterprises.png b/docs/enterprise-cloud/images/Codacy-Enterprises.png new file mode 100644 index 0000000000..a29e98d3eb Binary files /dev/null and b/docs/enterprise-cloud/images/Codacy-Enterprises.png differ diff --git a/docs/faq/general/how-does-codacy-support-github-enterprise.md b/docs/faq/general/how-does-codacy-support-github-enterprise.md index 8e3502c7ac..331e101bc4 100644 --- a/docs/faq/general/how-does-codacy-support-github-enterprise.md +++ b/docs/faq/general/how-does-codacy-support-github-enterprise.md @@ -12,3 +12,7 @@ Currently, the integration between Codacy and GitHub Enterprise has the followin - **Repositories with visibility Internal** will, in Codacy, have the same behavior as Private visibility. Although you see the repository in the provider, if you are not part of the repository in the provider, you will not be able to see it in Codacy. - **Same email connected to multiple GitHub accounts.** Codacy will not allow you to connect your enterprise account if that email is already associated with a different GitHub account. You can manage your [associated emails in the provider GitHub](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account). + +## See also + +- [How to manage your GitHub Enterprise organization](../../enterprise-cloud/github-enterprise-cloud.md) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 9935d68790..6b6b78132a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -611,6 +611,8 @@ nav: - organizations/audit-logs-for-organizations.md - organizations/roles-and-permissions-for-organizations.md - organizations/changing-your-plan-and-billing.md + - Enterprise Cloud: + - enterprise-cloud/github-enterprise-cloud.md - Your account: - account/managing-your-profile.md - account/emails.md