Skip to content

Commit 9f05864

Browse files
authored
doc: add documentation for open issues ALA-1419 (#2342)
* doc: add documentation for open issues ALA-1419 * AI proof read changes
1 parent 829820d commit 9f05864

15 files changed

+70
-33
lines changed

Diff for: docs/organizations/images/issues-activity.png

92.5 KB
Loading
84.1 KB
Loading
63 KB
Loading

Diff for: docs/organizations/images/open-issues-dashboard.png

377 KB
Loading
Loading
Loading

Diff for: docs/organizations/images/open-issues-ranking.png

149 KB
Loading
103 KB
Loading
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading

Diff for: docs/organizations/images/organization-overview.png

-87.1 KB
Binary file not shown.

Diff for: docs/organizations/issues-metrics.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
description: The organization's Issues dashboard provides an overview of all the issues detected in the repositories belonging to your Git provider organization.
3+
---
4+
5+
# Issues Metrics
6+
7+
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).
8+
9+
![Open issues dashboard](images/open-issues-dashboard.png)
10+
11+
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.
12+
13+
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.
14+
15+
![Open issues tab options](images/open-issues-tab-options.png)
16+
17+
The Issues Metrics dashboard includes the following sections to help you monitor the issues detected in your repositories:
18+
19+
- [Open issues by severity](#open-issues-by-severity)
20+
- [Open issues by category](#open-issues-by-category)
21+
- [Open issues evolution](#open-issues-evolution)
22+
- [Issues activity](#issues-activity)
23+
- [Repositories with the most issues](#repositories-with-the-most-issues)
24+
25+
!!! tip
26+
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.
27+
28+
## Open Issues by Severity
29+
30+
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.
31+
32+
![Open issues by severity](images/open-issues-by-severity.png)
33+
34+
## Open Issues by Category
35+
36+
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.
37+
38+
![Open issues by category](images/open-issues-by-category.png)
39+
40+
## Open Issues Evolution
41+
42+
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.
43+
44+
!!! important
45+
Data for each period represents an average of the values during that period.
46+
47+
![Open issues evolution by severity](images/open-issues-evolution-by-severity.png)
48+
49+
![Open issues evolution by category](images/open-issues-evolution-by-category.png)
50+
51+
## Issues Activity
52+
53+
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.
54+
55+
![Issues activity](images/issues-activity.png)
56+
57+
## Repositories with the Most Issues
58+
59+
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.
60+
61+
![Open issues ranking](images/open-issues-ranking.png)

Diff for: docs/organizations/organization-overview.md

+9-33
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
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.
2+
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.
33
---
44

55
# Organization overview
@@ -8,24 +8,13 @@ The **Organization overview** provides an overview of the repositories belonging
88

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

11-
!!! important
12-
- 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.
13-
14-
- The Organization overview displays information for **at most the last 100 updated repositories**.
15-
16-
![Organization overview](images/organization-overview.png)
17-
1811
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.
1912

20-
You can use the language filter to help you narrow down the list of repositories in the drop-down list:
21-
22-
![Using the language filter to narrow down the list of repositories](images/organization-overview-filter-language.png)
23-
2413
On the Organization overview you have the following areas to help you monitor your repositories:
2514

2615
- [Overall quality chart](#overall-quality-chart)
27-
- [Open pull requests](#open-pull-requests)
2816
- [Last updated repositories](#last-updated-repositories)
17+
- [Issues metrics](issues-metrics.md)
2918

3019
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.
3120

@@ -35,7 +24,12 @@ The following sections provide a detailed description of the repository-related
3524

3625
## Overall quality chart
3726

38-
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.
27+
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.
28+
29+
!!! important
30+
- 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.
31+
32+
- The overall quality chart displays information for **at most the last 100 updated repositories**.
3933

4034
![Overall quality chart](images/organization-overview-overall-quality.png)
4135

@@ -49,28 +43,10 @@ If you have over 8 repositories, the chart displays your repositories grouped by
4943
!!! tip
5044
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).
5145

52-
## Open pull requests
53-
54-
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.
55-
56-
![Most problematic pull requests](images/organization-overview-prs-problematic.png)
57-
58-
The **Last updated** tab displays open pull requests sorted by the date of update with one of the following status:
59-
60-
- Not up to standards
61-
- Up to standards
62-
- Analysis failed (something went wrong during the analysis)
63-
- Analyzing (intermediate status while Codacy is analyzing the pull request)
64-
65-
![Last updated pull requests](images/organization-overview-prs-last-updated.png)
66-
67-
Click a pull request to see the [details of that pull request](../repositories/pull-requests.md#status).
6846

6947
## Last updated repositories
7048

71-
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.
72-
73-
Click **See all** to see all the repositories that you follow on Codacy.
49+
The **Last updated repositories** list displays the last updated repositories, sorted by reverse date of the last update.
7450

7551
![Last updated repositories](images/organization-overview-repositories-last-updated.png)
7652

0 commit comments

Comments
 (0)