Skip to content

Commit

Permalink
ready for review
Browse files Browse the repository at this point in the history
  • Loading branch information
RaquelHipolito authored and inesgomas committed Dec 16, 2024
1 parent 330e3aa commit ee64f48
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions docs/enterprise-cloud/github-enterprise-cloud.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
# GitHub Enterprise Cloud

When you use GitHub Enterprise to sign up or log into Codacy, the GitHub Enterprise organizations, that you belong to, will be available to be added as Organizations on Codacy.
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.

Check failure on line 3 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'signup'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'signup'?", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 3, "column": 45}}}, "severity": "ERROR"}

After connecting with your Enterprise account Codacy displays the list of all organizations that you have access to in that Enterprise, and you can add to start analysing its repositories or join it.
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. In codacy app, click on your avatar image, in the top right corner, then navigate throught "My account" and "Access management". 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.
Access you enterprises in Codacy by setting up its integration:
1. In codacy app, click on your avatar image, in the top right corner

Check failure on line 12 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Terms] Use 'Codacy' instead of 'codacy'. Raw Output: {"message": "[Vale.Terms] Use 'Codacy' instead of 'codacy'.", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 12, "column": 7}}}, "severity": "ERROR"}
2. then navigate throught "My account" and "Access management"

Check failure on line 13 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'throught'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'throught'?", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 13, "column": 18}}}, "severity": "ERROR"}
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.

Check failure on line 16 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'infomration'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'infomration'?", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 16, "column": 62}}}, "severity": "ERROR"}
You can revoke the cloud enterpises access at any time in the same place.

Check warning on line 17 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Terms] Prefer 'cloud' over 'the cloud'. Raw Output: {"message": "[Microsoft.Terms] Prefer 'cloud' over 'the cloud'.", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 17, "column": 16}}}, "severity": "WARNING"}

Check failure on line 17 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'enterpises'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'enterpises'?", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 17, "column": 26}}}, "severity": "ERROR"}
![Enterprise cloud manage enterprises access](images/Codacy-Access-Management.png)

Expand All @@ -18,20 +23,22 @@ You can revoke the cloud enterpises access at any time in the same place.
- [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.

Check failure on line 26 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'signup'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'signup'?", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 26, "column": 6}}}, "severity": "ERROR"}

Once signed up or login with your GitHub enterprise account and, settingup access to could enterprises (LINK TO ABOVE), navigate to your Enterprises area. There you can manage the git Enterprises that are 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.
!!! 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
View a enterprise organization and access its list of organizations.
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.
![Enterprise cloud manage seats](images/Codacy-Enterprise-Seats.png)
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.

Check failure on line 41 in docs/enterprise-cloud/github-enterprise-cloud.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Microsoft.Contractions] Use 'won't' instead of 'will not'. Raw Output: {"message": "[Microsoft.Contractions] Use 'won't' instead of 'will not'.", "location": {"path": "docs/enterprise-cloud/github-enterprise-cloud.md", "range": {"start": {"line": 41, "column": 25}}}, "severity": "ERROR"}

### Limitations
Currently, the integration between Codacy and GitHub Enterprise has the following limitations:
Expand Down

0 comments on commit ee64f48

Please sign in to comment.