Skip to content
Closed
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
10 changes: 5 additions & 5 deletions docs/faq/code-analysis/which-metrics-does-codacy-calculate.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Codacy displays grades on the following places:
|[Files page](../../repositories/files.md)|Grade for each file in your repository|
|[Repository Dashboard](../../repositories/repository-dashboard.md)<br/>[Codacy badge](../../getting-started/adding-a-codacy-badge.md)|Grade of each analyzed branch in your repository|
|[Email notifications](../../account/emails.md#managing-your-email-notifications)|Grade of your repository|
|[Organization overview](../../organizations/organization-overview.md)|Average grade of the repositories in your organization and grade of each repository|
|[Organization overview](../../organizations/reporting/organization-overview.md)|Average grade of the repositories in your organization and grade of each repository|
|[Repositories list](../../organizations/managing-repositories.md)|Grade of each repository in your organization|

## Issues
Expand Down Expand Up @@ -73,7 +73,7 @@ Codacy displays issues on the following places:
|[Files page](../../repositories/files.md)|Number of issues in each file|
|[Issues page](../../repositories/issues.md)|List of all issues detected in each branch|
|[Repository Dashboard](../../repositories/repository-dashboard.md)|Issues per 1000 lines of code|
|[Organization overview](../../organizations/organization-overview.md)|Average issues / kLoC of the repositories in your organization and issue / kLoC of each repository|
|[Organization overview](../../organizations/reporting/organization-overview.md)|Average issues / kLoC of the repositories in your organization and issue / kLoC of each repository|
|[Repositories list page](../../organizations/managing-repositories.md)|Issues / kLoC in each repository in your organization|

## Complexity
Expand All @@ -93,7 +93,7 @@ Codacy displays complexity on the following places:
|[Commit detail page](../../repositories/commits.md)<br/>[Pull request detail page](../../repositories/pull-requests.md)<br/>[Email notifications](../../account/emails.md#managing-your-email-notifications)|The complexity variation introduced by a commit or pull request is calculated by summing the complexity differences of all changed files where the difference is 4 or more.
|[Files page](../../repositories/files.md)|The file complexity value is the sum of the complexity values of all methods defined within the file|
|[Repository Dashboard](../../repositories/repository-dashboard.md)|Percentage of complex files in your repository and how the metric is evolving over time|
|[Organization overview](../../organizations/organization-overview.md)|Average percentage of complex files in the repositories in your organization and percentage of complex files in each repository|
|[Organization overview](../../organizations/dashboards/organization-overview.md)|Average percentage of complex files in the repositories in your organization and percentage of complex files in each repository|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM RISK

The link path is incorrect. It should point to the reporting directory rather than dashboards.

This might be a simple fix:

Suggested change
|[Organization overview](../../organizations/dashboards/organization-overview.md)|Average percentage of complex files in the repositories in your organization and percentage of complex files in each repository|
[Organization overview](../../organizations/reporting/organization-overview.md)|Average percentage of complex files in the repositories in your organization and percentage of complex files in each repository|

|[Repositories list page](../../organizations/managing-repositories.md)|Percentage of complex files in each repository in your organization|

## Duplication
Expand All @@ -116,7 +116,7 @@ Codacy displays duplication on the following places:
|[Commit detail page](../../repositories/commits.md)<br/>[Pull request detail page](../../repositories/pull-requests.md)<br/>[Email notifications](../../account/emails.md#managing-your-email-notifications)|Number of clones added or fixed by a commit or pull request|
|[Files page](../../repositories/files.md)|Duplication value of each file|
|[Repository Dashboard](../../repositories/repository-dashboard.md)|Percentage of duplicated files in your repository and how the metric is evolving over time|
|[Organization overview](../../organizations/organization-overview.md)|Average percentage of duplicated files in the repositories in your organization and percentage of complex files in each repository|
|[Organization overview](../../organizations/dashboards/organization-overview.md)|Average percentage of duplicated files in the repositories in your organization and percentage of complex files in each repository|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM RISK

The link path is incorrect. It should point to the reporting directory.

This might be a simple fix:

Suggested change
|[Organization overview](../../organizations/dashboards/organization-overview.md)|Average percentage of duplicated files in the repositories in your organization and percentage of complex files in each repository|
[Organization overview](../../organizations/reporting/organization-overview.md)|Average percentage of duplicated files in the repositories in your organization and percentage of complex files in each repository|

|[Repositories list page](../../organizations/managing-repositories.md)|Percentage of duplicated files in each repository in your organization|

## Code coverage
Expand Down Expand Up @@ -151,7 +151,7 @@ Once the coverage setup is complete, Codacy displays coverage data on the follow
|[Files page](../../repositories/files.md)|Coverage percentage of each file|
|[Repository Dashboard](../../repositories/repository-dashboard.md)|Coverage of the most recent commit of the selected branch and its evolution over time|
|[Codacy badge](../../getting-started/adding-a-codacy-badge.md)|Coverage of the most recent commit of the configured branch|
|[Organization overview](../../organizations/organization-overview.md)|Average coverage of the repositories in your organization and coverage of each repository|
|[Organization overview](../../organizations/dashboards/organization-overview.md)|Average coverage of the repositories in your organization and coverage of each repository|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM RISK

The link path is incorrect. It should point to the reporting directory.

This might be a simple fix:

Suggested change
|[Organization overview](../../organizations/dashboards/organization-overview.md)|Average coverage of the repositories in your organization and coverage of each repository|
[Organization overview](../../organizations/reporting/organization-overview.md)|Average coverage of the repositories in your organization and coverage of each repository|

|[Repositories list page](../../organizations/managing-repositories.md)|Coverage of each repository in your organization|

## See also
Expand Down
2 changes: 1 addition & 1 deletion docs/organizations/managing-repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Across the application, Codacy calculates and displays data for the repositories

![Repositories list](images/repositories.png)

This page lists the repositories that you follow on Codacy sorted by [last updated date](organization-overview.md#last-updated-repositories), and allows you to compare the repositories on the list according to the following metrics:
This page lists the repositories that you follow on Codacy sorted by [last updated date](dashboards/organization-overview.md#last-updated-repositories), and allows you to compare the repositories on the list according to the following metrics:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM RISK

The relative link path is incorrect. Since this file is in the organizations root, it should point to reporting/organization-overview.md.

This might be a simple fix:

Suggested change
This page lists the repositories that you follow on Codacy sorted by [last updated date](dashboards/organization-overview.md#last-updated-repositories), and allows you to compare the repositories on the list according to the following metrics:
This page lists the repositories that you follow on Codacy sorted by [last updated date](reporting/organization-overview.md#last-updated-repositories), and allows you to compare the repositories on the list according to the following metrics:


- [Grade](../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade)
- [Issues](../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# AI Risk Hub

The **AI Risk Hub** dashboard provides an overview of all the AI issues detected in the repositories applied to the organization's AI Policy standard and your organization's risk level based on your AI practices. Here, you can navigate through the issues detected in your repositories and filter them by severity and category. You can also filter the issues by selecting specific repositories or using [the segments that you have set up](segments.md).
The **AI Risk Hub** dashboard provides an overview of all the AI issues detected in the repositories applied to the organization's AI Policy standard and your organization's risk level based on your AI practices. Here, you can navigate through the issues detected in your repositories and filter them by severity and category. You can also filter the issues by selecting specific repositories or using [the segments that you have set up](../segments.md).

!!! important
Currently this tab is a preview of a Business tier feature.
Expand Down Expand Up @@ -52,7 +52,7 @@
This list displays repositories in descending order based on the number of AI issues. Depending on the filters applied, the list will show repositories with the most AI open issues, grouped by severity or AI category.


![Repositories with most AI issues](images/repositories-with-most-ai-issues.png)
![Repositories with most AI issues](../images/repositories-with-most-ai-issues.png)

## Risk Level

Expand All @@ -67,10 +67,10 @@
With most repositories today being subject to GenAI code contributions, the checklist covers essential source code controls that we recommend to enable across all projects within your organization:

- AI Policy enabled: Enable the AI Policy inside the AI Risk Hub tab.
- Coverage enabled: Set up code coverage for your repositories. See how to [upload coverage data](../coverage-reporter/index.md) to Codacy.
- Enforced gates: Add [gates to your repositories](../repositories-configure/adjusting-quality-gates.md), and preferentially [apply repositories to gate policies](./using-gate-policies.md).
- Protected pull requests: Protect your pull requests by [enforcing quality gates](../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests).
- Daily vulnerability scans: [Enable Proactive SCA](./managing-security-and-risk.md#dependencies-list) to protect your repositories from dependencies vulnerabilities.
- Applications scanned: [Enable App scanning](./managing-security-and-risk.md#app-scanning) to scan Web Applications and APIs for security vulnerabilities.
- Coverage enabled: Set up code coverage for your repositories. See how to [upload coverage data](../../coverage-reporter/index.md) to Codacy.
- Enforced gates: Add [gates to your repositories](../../repositories-configure/adjusting-quality-gates.md), and preferentially [apply repositories to gate policies](../using-gate-policies.md).
- Protected pull requests: Protect your pull requests by [enforcing quality gates](../../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests).
- Daily vulnerability scans: [Enable Proactive SCA](../managing-security-and-risk.md#dependencies-list) to protect your repositories from dependencies vulnerabilities.
- Applications scanned: [Enable App scanning](../managing-security-and-risk.md#app-scanning) to scan Web Applications and APIs for security vulnerabilities.

Check failure on line 74 in docs/organizations/reporting/ai-risk-hub.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'APIs'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'APIs'?", "location": {"path": "docs/organizations/reporting/ai-risk-hub.md", "range": {"start": {"line": 74, "column": 123}}}, "severity": "ERROR"}

![AI Risk Checklist](images/ai-risk-checklist.png)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Codacy usage

The **Codacy usage** dashboard provides an overview of your organization's configurations and their impact. You can filter repositories by quality gates and coverage, select specific repositories, or use [the segments that you have set up](segments.md).
The **Codacy usage** dashboard provides an overview of your organization's configurations and their impact. You can filter repositories by quality gates and coverage, select specific repositories, or use [the segments that you have set up](../segments.md).

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

Expand Down Expand Up @@ -29,13 +29,13 @@ This chart displays the distribution of repositories that are and are not in Cod
!!! note
Repository coverage data is based on the last merged pull request, meaning that if a repository has coverage setup but coverage was not sent in the last merged PR, it will not count as a repository with Coverage.

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

## Repositories evolution

This chart shows the trend of repositories in your organization over time, considering the filters applied, affecting the **Repositories list**. 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.

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

## Merged pull requests

Expand All @@ -55,14 +55,14 @@ If you see high numbers here, it usually boils down to two scenarios:

1. A developer merged the PR immediately after opening it, before the Codacy analysis could finish. To improve this, ensure your team adjusts their workflow to wait for the "Codacy/Analysis" check to turn green before merging or by making the Codacy status check mandatory.

2. In organizations with manual user management (check your billing settings), if a PR is authored by an email/user not yet added to your Codacy seat count, the analysis may be skipped. You should check your [seat management](../organizations/managing-people.md) to confirm that all active contributors are correctly mapped to a Codacy seat.”
2. In organizations with manual user management (check your billing settings), if a PR is authored by an email/user not yet added to your Codacy seat count, the analysis may be skipped. You should check your [seat management](../managing-people.md) to confirm that all active contributors are correctly mapped to a Codacy seat.”


#### Why are some PRs merged with "Failing gates"?

Pull requests are merged with failing Quality Gates usually due to two reasons:

1. Quality Gates are advisory, not blocking. [Protect your pull requests](../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests).
1. Quality Gates are advisory, not blocking. [Protect your pull requests](../../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests).

2. Intentional exceptions or risk acceptance:
- Developers/maintainers may override failing checks to address urgent fixes, unblock critical work, or accept a known risk temporarily.
Expand All @@ -80,4 +80,4 @@ Interacting with the chart allows you to filter the data, with the resulting rep

The list shows a maximum of 10 repositories from your Git provider. You can use filters to display repositories that aren't 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. Despite the 10 repository limit, the Repositories list section allows you to download a list up to 100 repositories.

![Repositories list](images/repositories-list.png)
![Repositories list](../images/repositories-list.png)
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The organization's Issues dashboard provides an overview of all the

# Issues metrics

The **Issues metrics** dashboard provides an overview of all the issues detected in the repositories belonging to your Git provider organization. Here, you can navigate through the issues detected in your repositories and filter them by severity and category. You can also filter the issues by selecting specific repositories or using [the segments that you have set up](segments.md).
The **Issues metrics** dashboard provides an overview of all the issues detected in the repositories belonging to your Git provider organization. Here, you can navigate through the issues detected in your repositories and filter them by severity and category. You can also filter the issues by selecting specific repositories or using [the segments that you have set up](../segments.md).

![Open issues dashboard](images/open-issues-dashboard.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: The Organization overview provides an overview of the repositories

# Organization overview

The **Organization overview** provides an overview of 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.
The **Organization overview** provides an overview of 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.

To access your Organization overview, select an organization from the top navigation bar and select **Overview** on the left navigation sidebar.

Expand All @@ -20,11 +20,11 @@ On this page, you can also see the **Organization setup** area, which provides y

The following sections provide a detailed description of the repository-related dashboard areas.

{% include-markdown "../assets/includes/dashboard-api-report-note.md" %}
{% include-markdown "../../assets/includes/dashboard-api-report-note.md" %}

## Overall quality chart

The **Overall quality** chart compares the repositories that you follow regarding [grade](../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade), [issues](../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues), [complex files](../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity), [duplication](../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication), and [code coverage](../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage). Each tab displays the average value for the corresponding metric for the last updated repositories.
The **Overall quality** chart compares the repositories that you follow regarding [grade](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#grade), [issues](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#issues), [complex files](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#complexity), [duplication](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#duplication), and [code coverage](../../faq/code-analysis/which-metrics-does-codacy-calculate.md#code-coverage). Each tab displays the average value for the corresponding metric for the last updated repositories.

!!! important
- 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.
Expand All @@ -41,7 +41,7 @@ If you have over 8 repositories, the chart displays your repositories grouped by
![Overall quality chart with grouped repositories](images/organization-overview-overall-quality-grouped.png)

!!! tip
If you don't have coverage set up for any of your repositories yet, the coverage tab provides you with instructions on [how to add coverage for your repositories](../coverage-reporter/index.md).
If you don't have coverage set up for any of your repositories yet, the coverage tab provides you with instructions on [how to add coverage for your repositories](../../coverage-reporter/index.md).


## Last updated repositories
Expand All @@ -59,6 +59,6 @@ The **Last updated repositories** list displays the last updated repositories, s

## See also

- [Which metrics does Codacy calculate?](../faq/code-analysis/which-metrics-does-codacy-calculate.md)
- [Using the Codacy API to obtain current issues in repositories](../codacy-api/examples/obtaining-current-issues-in-repositories.md)
- [Using the Codacy API to obtain code quality metrics for files](../codacy-api/examples/obtaining-code-quality-metrics-for-files.md)
- [Which metrics does Codacy calculate?](../../faq/code-analysis/which-metrics-does-codacy-calculate.md)
- [Using the Codacy API to obtain current issues in repositories](../../codacy-api/examples/obtaining-current-issues-in-repositories.md)
- [Using the Codacy API to obtain code quality metrics for files](../../codacy-api/examples/obtaining-code-quality-metrics-for-files.md)
2 changes: 1 addition & 1 deletion docs/release-notes/cloud/cloud-2022-02.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ These release notes are for the Codacy Cloud updates during February 2022.

## Product enhancements

- The [**Overall quality** chart](../../organizations/organization-overview.md#overall-quality-chart) now allows drilling down on the information to understand which repositories require attention to improve the organization's code quality. (Beta) (CY-5580)
- The [**Overall quality** chart](../../organizations/reporting/organization-overview.md#overall-quality-chart) now allows drilling down on the information to understand which repositories require attention to improve the organization's code quality. (Beta) (CY-5580)

![Drilling down on the Overall quality chart](../images/cy-5580.png)

Expand Down
Loading
Loading