Skip to content

Commit 117bc57

Browse files
committed
apply lipe review
1 parent 7f3653f commit 117bc57

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/organizations/codacy-usage.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Codacy usage
22

3-
The **Codacy usage** dashboard provides an overview of how your organization is adopting Codacy. You can view and filter the list of repositories from your Git provider. You can also filter repositories in Codacy by gate and coverage information. You can also filter by selecting specific repositories or using [the segments that you have set up](segments.md).
3+
The **Codacy usage** dashboard offers an overview of your organization's adoption of Codacy. You can filter the displayed list of repositories by their Git provider, as well as by their gate and coverage information within Codacy. Additionally, you can filter by selecting specific repositories or by using [the segments that you have set up](segments.md).
44

55
![Codacy usage dashboard](images/codacy-usage-dashboard.png)
66

77
!!! important
88
Repositories not in Codacy is only available to GitHub accounts.
99

10-
To access the Codacy usage dashboard, select an organization from the top navigation bar and click on the **Codacy usage** tab at the top of the page.
10+
To view the **Codacy usage** dashboard:
1111

12-
On the tab, if your Git provider is GitHub, you can view the percentage of repositories added to Codacy. Otherwise, you'll see the total number of repositories in Codacy.
12+
- Select an organization from the top navigation bar.
13+
- On the organization overview page, click the Codacy usage tab.
1314

1415
The Codacy usage dashboard includes the following sections to help you monitor Codacy adoption:
1516

@@ -23,22 +24,26 @@ The Codacy usage dashboard includes the following sections to help you monitor C
2324

2425
## Repositories
2526

26-
This chart displays the distribution of repositories in Codacy and repositories not in Codacy. On the pie chart, around the number of repositories in Codacy, you can also see the distribution of repositories without gates, without coverage, without gates nor coverage, and with gates and coverage. You can click both on the pie chart and numbers to filter the results in the rest of the dashboard.
27+
This chart displays the distribution of repositories in Codacy and repositories that are not. The doughnut chart also details the breakdown of Codacy repositories based on their configuration: those without quality gates, without coverage, without either gates or coverage, and those with both gates and coverage. Users can interact with the doughnut chart or the numerical data to filter the results. Applying a filter will also affect the repositories displayed in the evolution chart and the results will appear in the "Top repositories" list.
2728

2829
![Repositories distribution](images/repositories-distribution.png)
2930

3031
## Repositories evolution
3132

32-
This chart shows the trend of repositories in your organization over time, considering the filters applied. You can hover over the chart to see the number of repositories on a specific date. You can also click on the chart to filter results in the dashboard.
33-
34-
!!! important
35-
Data for each period represents an average of the values during that period.
33+
This chart shows the trend of repositories in your organization over time, considering the filters applied. You can hover over the chart to see the number of repositories on a specific date. You can also click on the chart to filter results.
3634

3735
![Repositories evolution](images/repositories-evolution.png)
3836

3937
## Merged pull requests
4038

41-
This chart displays the number of pull requests merged in your repositories. Merged pull requests are distributed in two main categories - analyzed and not analyzed. Analyzed merged pull requests are shown in three different categories - passing gates, failing gates, and without gates. You can click on the chart to filter results in the dashboard.
39+
This chart displays the number of pull requests merged in your repositories, categorizing them as either analyzed or not analyzed.
40+
Analyzed PRs are further broken down into three sub-categories:
41+
42+
- Passing Gates: Merged PRs that successfully passed all quality gates.
43+
- Failing Gates: Merged PRs that failed one or more quality gates.
44+
- Without Gates: Merged PRs where no quality gates were configured or applied.
45+
46+
Interacting with the chart allows you to filter the data, with the resulting repositories displayed in the "Top repositories" list.
4247

4348
!!! note
4449
Merged pull requests data is only from repositories that are in Codacy.
@@ -47,6 +52,6 @@ This chart displays the number of pull requests merged in your repositories. Mer
4752

4853
## Top repositories
4954

50-
This list displays a maximum of 10 repositories in your Git provider. Depending on the filters applied, the list will show repositories not in Codacy, repositories in Codacy, or repositories in Codacy grouped by a specific dimension, such as gates information and/or coverage information.
55+
The list shows a maximum of 10 repositories from your Git provider. You can use filters to display repositories that are not yet in Codacy, or repositories that are already in Codacy. For repositories in Codacy, the list can also group them by specific metrics such as gates, coverage, and merged pull request information.
5156

5257
![Top repositories](images/top-repositories.png)

0 commit comments

Comments
 (0)