You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/organizations/reporting/organization-overview.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: The Organization overview provides an overview of the repositories
4
4
5
5
# Organization overview
6
6
7
-
Codacy guarantees you high-level visibility of your organization regarding its code quality, security positioning, AI risks, and Codacy's usage and configurations. In the **Organization overview**, you'll be able to see all these metrics at a glance.
7
+
Codacy gives you high-level visibility into your organization's code quality, security posture, AI risks, and usage and configuration metrics. In the **Organization overview**, you can see these metrics at a glance.
8
8
9
9
The **Organization overview** summarizes the repositories belonging to your Git provider organization that you [follow on Codacy](../managing-repositories.md). Here you can compare their statuses and check for items that require your attention.
10
10
@@ -20,18 +20,18 @@ The Organization overview contains the following tabs:
20
20
-[Complexity](#complexity)
21
21
-[Duplication](#duplication)
22
22
-[Coverage](#coverage)
23
-
-[Codacy Usage](./codacy-usage.md)
23
+
-[Codacy usage](./codacy-usage.md)
24
24
-[AI Risk Hub](./ai-risk-hub.md)
25
25
26
-
<divid="overview-filters">You can use the filters at the top of the page to filter all information displayed by the repositories or segments that you select. For example, you can use the filter to monitor the quality of the repositories maintained by specific teams or that include certain programming languages, or to ignore legacy repositories that are no longer maintained. Your filter selection is stored in your browser so that you can keep your focus between your visits.</div>
26
+
<divid="overview-filters">Use the filters at the top of the page to filter all dashboard information by repositories or segments. For example, use filters to monitor repositories maintained by specific teams or repositories using specific programming languages, or to ignore legacy repositories that are no longer maintained. Your filter selection is stored in your browser, so your view is preserved between visits.</div>
27
27
28
-
On this page, we'll cover the Overview section, along with the Grade, Complexity, Duplication, and Coverage sections.
28
+
This page covers the Overview, Grade, Complexity, Duplication, and Coverage sections.
@@ -43,26 +43,26 @@ On this page, you can also see the **Organization setup** area, which provides y
43
43
44
44

45
45
46
-
The **Code health and security** provides a snapshot of your organization and its hotspots. Here you can see at a glance the number of Open Issues, New vs Fixed issues, Prevented issues, along with complexity, duplication, coverage and security metrics. You can click on any of these metrics to go into more details on each section.
46
+
The **Code health and security**area provides a snapshot of your organization and key hotspots. Here, you can see at a glance open issues, new vs. fixed issues, prevented issues, and complexity, duplication, coverage, and security metrics. You can click any metric to see more details.
47
47
48
-
Some of these metrics will be dependent on your billing plan, and are calculated based on different factors. To understand more, you can check the table below:
48
+
Some of these metrics depend on your billing plan and are calculated differently. For details, see the following table:
49
49
50
50
| Metric | Availability | How it is calculated |
51
51
| ------ | ------------ | -------------------- |
52
52
| Open issues, New and Fixed issues, and Prevented issues | Paid plans |[More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues)|
53
-
| Grade | Open source & Trials|[More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade)|
53
+
| Grade | Open source and trial plans|[More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade)|
54
54
| Complexity | All plans |[More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity)|
55
55
| Duplication | All plans |[More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication)|
56
-
| Coverage | All plans <ahref="#coverage"><sup>1</sup></a>|[More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage)|
56
+
| Coverage | All plans <ahref="#coverage-note"><sup>1</sup></a>|[More details](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage)|
57
57
| Security | All plans |[More details](../managing-security-and-risk.md)|
58
58
59
59
60
60
!!! important
61
61
- The overall quality chart calculates metrics and displays data only for the **repositories that you follow** on Codacy. This means that depending on their list of followed repositories, two users can see different results on this chart.
62
62
63
-
- Metrics like Grade, Complexity, Duplication, and Coverage (on free plans) only represent **at most the last 100 updated repositories**.
63
+
- Metrics like grade, complexity, duplication, and coverage (on free plans) represent **at most the last 100 updated repositories**.
64
64
65
-
<sup><spanid="coverage">1</span></sup>: The way that coverage metrics are calculated is different between Paid, and Open source and trials. [Learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage)
65
+
<sup><spanid="coverage-note">1</span></sup>: Coverage metrics are calculated differently for paid plans and for open source and trial plans. [Learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage).
66
66
67
67
### Last updated repositories
68
68
@@ -81,7 +81,7 @@ The **Last updated repositories** list displays the last updated repositories, s
81
81
82
82

83
83
84
-
Grade tab will give you visibility over the distributions of Grades across your repositories. From this tab, you can understand which repositories are most at risk by selecting a grade from the distribution chart. This will help you prioritize which repositories need more attention.
84
+
The **Grade** tab gives you visibility into grade distribution across your repositories. From this tab, you can identify the repositories with the highest risk by selecting a grade in the distribution chart.
85
85
86
86
To learn more about how grades are calculated [see how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade).
87
87
@@ -94,11 +94,11 @@ To learn more about how grades are calculated [see how metrics are calculated](.
94
94
95
95
Complexity allows you to understand which repositories are at risk of having code that is more difficult to test and more likely to have defects.
96
96
97
-
In this tab, you'll be able to understand your complexity positioning (based on the number of complex files) at an organization level, plus how repos stack according to their [Goals](../../repositories-configure/adjusting-quality-goals.md). We consider a file "complex" if its cyclomatic complexity value is higher than the goal defined at a repository level. To learn about what we consider a complex file, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity).
97
+
In this tab, you can understand your organization's complexity status (based on the number of complex files) and how repositories compare against their [goals](../../repositories-configure/adjusting-quality-goals.md). A file is considered complex if its cyclomatic complexity value is higher than the goal defined at repository level. To learn more, see [how metrics are calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity).
98
98
99
-
From this panel you can understand, from the list of the top 100 most recently updated repositories, which ones are above, below or don't have a goal. Since complexity is a "depreciative metric", repositories "above goal" will be the ones immediately flagged, so you can review and take action upon them.
99
+
This panel shows, from the top 100 most recently updated repositories, which repositories are above goal, below goal, or have no goal. Because complexity is better when lower, repositories above goal are highlighted so you can review and act on them.
100
100
101
-
On the bottom, you have a section where you can see the distribution of complex files, and here you can understand more clearly which files are complex because they are above goal, below goal, or without a goal on their repository. Files are not filterable, whereas the Repository goal distributions are.
101
+
At the bottom of the tab, the complex files distribution helps you understand which files are complex because they are above goal, below goal, or in repositories without a goal. Files are not filterable, while repository goal distributions are.
102
102
103
103
!!! important
104
104
Complexity metrics are based **at most on the last 100 updated repositories**.
@@ -108,7 +108,7 @@ On the bottom, you have a section where you can see the distribution of complex
108
108
109
109
Duplication allows you to check if sequences of duplicate code exist in at least two different places of the source code of your repository.
110
110
111
-
In this tab, you'll be able to see the average of duplication that you have in your repositores, check which repos has duplication above, bellow or without any[goals](../../repositories-configure/adjusting-quality-goals.md) set up.
111
+
In this tab, you can see your average duplication and check which repositories are above goal, below goal, or without configured[goals](../../repositories-configure/adjusting-quality-goals.md).
112
112
113
113
To learn more about duplication metrics, see [how duplication is calculated](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication).
114
114
@@ -120,29 +120,29 @@ To learn more about duplication metrics, see [how duplication is calculated](../
120
120
121
121

122
122
123
-
The Coverage tab provides you visibility at an organizationlevel of your organization-wide coverage positioning. Strong coverage positioning allows you to have better protection over your code and derisk code changes / breaking incidents.
123
+
The **Coverage** tab provides organization-level visibility into your coverage status. Strong coverage helps protect your code and reduce the risk of regressions when code changes.
124
124
125
125
!!! important
126
-
The coverage tab has two modes:
127
-
- On Trial and Open source plans, you're able to see your repository coverage average across the 100 most recently updated repositories. It provides visibility about which repositories are above, below or without goal, similar to the the other Duplication and Complexity tabs
128
-
- On Paid plans, we invested on providing wider visibility of your coverage positioning, removing the 100repository limitation, and providing important metrics on where to invest the most. This is the version of the dashboard that we'll cover on this documentation.
126
+
The Coverage tab has two modes:
127
+
- On trial and open source plans, you can see the average repository coverage across the 100 most recently updated repositories. This includes visibility into which repositories are above goal, below goal, or without a goal, similar to the Duplication and Complexity tabs.
128
+
- On paid plans, the dashboard removes the 100-repository limitation and provides additional metrics to help you prioritize improvements. This is the mode covered in this page.
129
129
130
130
To understand better how these metrics are calculated, [learn more](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage).
131
131
132
-
The Coverage tab is based on two defining metrics:
132
+
The Coverage tab is based on two key metrics:
133
133
134
134
-**Covered lines**: number of covered lines reported into Codacy;
135
135
-**Coverable lines**: number of lines that can be covered based on your coverage reports.
136
136
137
-
These are the basis to build all components on this dashboard. Here you'll find:
137
+
These metrics are the basis of all components in this dashboard:
138
138
139
139
| Metric | Description |
140
140
| ------ | ----------- |
141
-
|**Coverage**|_coveredLines / coverableLines_ <br/>Aggregation of all covered lines per coverable lines across all repositories (or filter selection, see [filters](#overview-filters)). This metric only concerns repositories that have coverage being reported. |
142
-
|**Repositories reporting coverage**| Repositories that have coverage, based on the latest merged pull request. e.g. If the last PR that was merged reported coverage metrics to Codacy, that repository is considered as having coverage. |
143
-
|**Coverage trend**| Trend over time of Covered Lines, Uncovered lines and the organization's (or filter selection, see [filters](#overview-filters))**Coverage** over time. You can select different time ranges and granularities, and even select a date to see which repositories had the biggest changes in that time period. |
141
+
|**Coverage**|_coveredLines / coverableLines_ <br/>Aggregation of all covered lines divided by all coverable lines across all repositories (or your filter selection, see [filters](#overview-filters)). This metric only includes repositories reporting coverage. |
142
+
|**Repositories reporting coverage**| Repositories that have coverage based on the latest merged pull request. For example, if the latest merged pull request reported coverage metrics to Codacy, that repository is counted as reporting coverage. |
143
+
|**Coverage trend**| Trend over time for covered lines, uncovered lines, and organization coverage (or your filter selection, see [filters](#overview-filters)). You can select different time ranges and granularities, and select a date to see which repositories changed most in that period. |
144
144
145
-
It's possible to download the data from each of these charts on the three dotted icons on the topright corners, where you can copy values in JSON or CSV format.
145
+
You can download data from each chart using the ellipsis icon in the top-right corner and export values in JSON or CSV format.
146
146
147
147
## See also
148
148
-[Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate.md)
0 commit comments