diff --git a/docs/organizations/images/issues-activity.png b/docs/organizations/images/issues-activity.png new file mode 100644 index 0000000000..9db814653b Binary files /dev/null and b/docs/organizations/images/issues-activity.png differ diff --git a/docs/organizations/images/open-issues-by-category.png b/docs/organizations/images/open-issues-by-category.png new file mode 100644 index 0000000000..2750116a5f Binary files /dev/null and b/docs/organizations/images/open-issues-by-category.png differ diff --git a/docs/organizations/images/open-issues-by-severity.png b/docs/organizations/images/open-issues-by-severity.png new file mode 100644 index 0000000000..2edaff58b2 Binary files /dev/null and b/docs/organizations/images/open-issues-by-severity.png differ diff --git a/docs/organizations/images/open-issues-dashboard.png b/docs/organizations/images/open-issues-dashboard.png new file mode 100644 index 0000000000..8d090f0f9e Binary files /dev/null and b/docs/organizations/images/open-issues-dashboard.png differ diff --git a/docs/organizations/images/open-issues-evolution-by-category.png b/docs/organizations/images/open-issues-evolution-by-category.png new file mode 100644 index 0000000000..b3043b0d66 Binary files /dev/null and b/docs/organizations/images/open-issues-evolution-by-category.png differ diff --git a/docs/organizations/images/open-issues-evolution-by-severity.png b/docs/organizations/images/open-issues-evolution-by-severity.png new file mode 100644 index 0000000000..541f7fb606 Binary files /dev/null and b/docs/organizations/images/open-issues-evolution-by-severity.png differ diff --git a/docs/organizations/images/open-issues-ranking.png b/docs/organizations/images/open-issues-ranking.png new file mode 100644 index 0000000000..8b8a9c8c5e Binary files /dev/null and b/docs/organizations/images/open-issues-ranking.png differ diff --git a/docs/organizations/images/open-issues-tab-options.png b/docs/organizations/images/open-issues-tab-options.png new file mode 100644 index 0000000000..c7fbeddcc8 Binary files /dev/null and b/docs/organizations/images/open-issues-tab-options.png differ diff --git a/docs/organizations/images/organization-overview-filter-language.png b/docs/organizations/images/organization-overview-filter-language.png deleted file mode 100644 index 616f35b1ec..0000000000 Binary files a/docs/organizations/images/organization-overview-filter-language.png and /dev/null differ diff --git a/docs/organizations/images/organization-overview-prs-last-updated.png b/docs/organizations/images/organization-overview-prs-last-updated.png deleted file mode 100644 index d5dc419e0c..0000000000 Binary files a/docs/organizations/images/organization-overview-prs-last-updated.png and /dev/null differ diff --git a/docs/organizations/images/organization-overview-prs-problematic.png b/docs/organizations/images/organization-overview-prs-problematic.png deleted file mode 100644 index ca8bc3b2f3..0000000000 Binary files a/docs/organizations/images/organization-overview-prs-problematic.png and /dev/null differ diff --git a/docs/organizations/images/organization-overview-repositories-last-updated.png b/docs/organizations/images/organization-overview-repositories-last-updated.png index d07eba15ac..f250b8838e 100644 Binary files a/docs/organizations/images/organization-overview-repositories-last-updated.png and b/docs/organizations/images/organization-overview-repositories-last-updated.png differ diff --git a/docs/organizations/images/organization-overview.png b/docs/organizations/images/organization-overview.png deleted file mode 100644 index e23f61375e..0000000000 Binary files a/docs/organizations/images/organization-overview.png and /dev/null differ diff --git a/docs/organizations/issues-metrics.md b/docs/organizations/issues-metrics.md new file mode 100644 index 0000000000..72bcf71395 --- /dev/null +++ b/docs/organizations/issues-metrics.md @@ -0,0 +1,61 @@ +--- +description: The organization's Issues dashboard provides an overview of all the issues detected in the repositories belonging to your Git provider organization. +--- + +# 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). + +![Open issues dashboard](images/open-issues-dashboard.png) + +To access the Issues Metrics dashboard, select an organization from the top navigation bar and click on the **Open Issues** tab at the top of the page. + +By default, the Issues Metrics dashboard displays metrics as the absolute number of issues. You can change the display to **Issues per 1,000 lines of code** by clicking on the ellipsis icon at the top right of the Open Issues tab. From here, you can also customize the period against which you want to compare the issues detected in your repositories. When available, comparisons against the previously selected period will be shown next to each value, and you can hover over the comparison to see the variation. + +![Open issues tab options](images/open-issues-tab-options.png) + +The Issues Metrics dashboard includes the following sections to help you monitor the issues detected in your repositories: + +- [Open issues by severity](#open-issues-by-severity) +- [Open issues by category](#open-issues-by-category) +- [Open issues evolution](#open-issues-evolution) +- [Issues activity](#issues-activity) +- [Repositories with the most issues](#repositories-with-the-most-issues) + +!!! tip + In each section, you can click on the ellipsis icon in the top right corner to export that section's data to CSV or JSON. + +## Open Issues by Severity + +This chart displays the current number of open issues detected in your repositories, grouped by severity. You can click on each severity level to filter the results in the rest of the dashboard. + +![Open issues by severity](images/open-issues-by-severity.png) + +## Open Issues by Category + +This chart displays the current number of open issues detected in your repositories, grouped by category. You can click on each category to filter the results in the rest of the dashboard. + +![Open issues by category](images/open-issues-by-category.png) + +## Open Issues Evolution + +This chart shows the trend of open issues in your repositories over time, either by severity or by category, depending on the filters applied. You can hover over the chart to see the number of open issues on a specific date. You can also click on the chart to filter results in the **Issues Activity** chart and the **Repositories with the Most Issues** list. + +!!! important + Data for each period represents an average of the values during that period. + +![Open issues evolution by severity](images/open-issues-evolution-by-severity.png) + +![Open issues evolution by category](images/open-issues-evolution-by-category.png) + +## Issues Activity + +This chart displays the number of issues fixed and introduced in your repositories over time. You can hover over the chart to see the number of issues fixed and introduced on a specific date. You can also click on the chart to filter results in the **Repositories with the Most Issues** list. + +![Issues activity](images/issues-activity.png) + +## Repositories with the Most Issues + +This list displays repositories in descending order based on the number of issues. Depending on the filters applied, the list will show repositories with the most open issues, grouped by severity or category, or within a specific period. + +![Open issues ranking](images/open-issues-ranking.png) diff --git a/docs/organizations/organization-overview.md b/docs/organizations/organization-overview.md index bdfdfc7fb0..6ca209b13e 100644 --- a/docs/organizations/organization-overview.md +++ b/docs/organizations/organization-overview.md @@ -1,5 +1,5 @@ --- -description: The Organization overview provides an overview of the repositories that you follow on Codacy. Here you can compare their statuses and check for items that require your attention. +description: The Organization overview provides an overview of the repositories belonging to your Git provider organization. Here you can compare their statuses and check for items that require your attention. --- # Organization overview @@ -8,24 +8,13 @@ The **Organization overview** provides an overview of the repositories belonging To access your Organization overview, select an organization from the top navigation bar and select **Overview** on the left navigation sidebar. -!!! important - - The Organization overview 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 their Organization overview. - - - The Organization overview displays information for **at most the last 100 updated repositories**. - -![Organization overview](images/organization-overview.png) - Use the drop-down list at the top of the page to filter the information displayed on all dashboard areas based on the repositories 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. The selected repositories are stored in your browser so that the same filter is applied between your visits to the Organization overview page. -You can use the language filter to help you narrow down the list of repositories in the drop-down list: - -![Using the language filter to narrow down the list of repositories](images/organization-overview-filter-language.png) - On the Organization overview you have the following areas to help you monitor your repositories: - [Overall quality chart](#overall-quality-chart) -- [Open pull requests](#open-pull-requests) - [Last updated repositories](#last-updated-repositories) +- [Issues metrics](issues-metrics.md) On this page, you can also see the **Organization setup** area, which provides you with a checklist of items that you should complete to ensure that your organization is set up correctly and that you're getting the most out of Codacy. @@ -35,7 +24,12 @@ The following sections provide a detailed description of the repository-related ## 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 across your 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. + + - The overall quality chart displays information for **at most the last 100 updated repositories**. ![Overall quality chart](images/organization-overview-overall-quality.png) @@ -49,28 +43,10 @@ If you have over 8 repositories, the chart displays your repositories grouped by !!! 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). -## Open pull requests - -The **Most problematic** tab displays a short list of the open pull requests that aren't up to standards and have the most potential to negatively affect your code quality. - -![Most problematic pull requests](images/organization-overview-prs-problematic.png) - -The **Last updated** tab displays open pull requests sorted by the date of update with one of the following status: - -- Not up to standards -- Up to standards -- Analysis failed (something went wrong during the analysis) -- Analyzing (intermediate status while Codacy is analyzing the pull request) - -![Last updated pull requests](images/organization-overview-prs-last-updated.png) - -Click a pull request to see the [details of that pull request](../repositories/pull-requests.md#status). ## Last updated repositories -The **Last updated repositories** list displays the last updated repositories, sorted by reverse date of the last update. Each item displays the date of the last update and the current grade of the repository. - -Click **See all** to see all the repositories that you follow on Codacy. +The **Last updated repositories** list displays the last updated repositories, sorted by reverse date of the last update. ![Last updated repositories](images/organization-overview-repositories-last-updated.png)