Skip to content

Commit 78d43b0

Browse files
authored
clean: Refactor docs on configuring who can ignore issues CY-3647 (#516)
* clean: Move "which users can ignore issues" to "roles and permissions" * clean: Link "Configurable" cells in table to new section * style: Tweak admonition indicating availability of feature * clean: Link "which users can ignore issues" and "Ignoring an issue" * fix: Adjust heading level * fix: Update URL fragment link * fix: Update superscript numeral
1 parent f65dc29 commit 78d43b0

File tree

5 files changed

+29
-31
lines changed

5 files changed

+29
-31
lines changed

docs/assets/includes/paid.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--start-paid-->
2-
!!! info "This feature is [only available on paid plans](https://www.codacy.com/pricing){: target="_blank"}."
2+
!!! info "This feature is [only available on paid plans](https://www.codacy.com/pricing){: target="_blank"}"
33
<!--end-paid-->
44

55
<!--start-paid-private-repositories-->
6-
!!! info "Analyzing private repositories is [only available on paid plans](https://www.codacy.com/pricing){: target="_blank"}."
6+
!!! info "Analyzing private repositories is [only available on paid plans](https://www.codacy.com/pricing){: target="_blank"}"
77
<!--end-paid-private-repositories-->

docs/organizations/configuring-which-users-can-ignore-issues.md

-16
This file was deleted.

docs/organizations/roles-and-permissions-for-synced-organizations.md

+17-8
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Depending on your role on the Git provider you will have different permissions o
3131
<tr>
3232
<td>Repository Read</td>
3333
<td>Yes<sup><a href="#note-2">2</a></sup></td>
34-
<td>Configurable<sup><a href="#note-3">3</a></sup></td>
34+
<td><a href="#configure-ignore-issues">Configurable</a></td>
3535
<td>No</td>
3636
<td>No</td>
3737
<td>Yes</td>
@@ -41,7 +41,7 @@ Depending on your role on the Git provider you will have different permissions o
4141
<tr>
4242
<td>Repository Triage</td>
4343
<td>Yes<sup><a href="#note-2">2</a></sup></td>
44-
<td>Configurable<sup><a href="#note-3">3</a></sup></td>
44+
<td><a href="#configure-ignore-issues">Configurable</a></td>
4545
<td>No</td>
4646
<td>No</td>
4747
<td>Yes</td>
@@ -51,7 +51,7 @@ Depending on your role on the Git provider you will have different permissions o
5151
<tr>
5252
<td>Repository Write</td>
5353
<td>Yes<sup><a href="#note-2">2</a></sup></td>
54-
<td>Configurable<sup><a href="#note-3">3</a></sup></td>
54+
<td><a href="#configure-ignore-issues">Configurable</a></td>
5555
<td>No</td>
5656
<td>Yes</td>
5757
<td>Yes</td>
@@ -61,7 +61,7 @@ Depending on your role on the Git provider you will have different permissions o
6161
<tr>
6262
<td>Repository Maintain</td>
6363
<td>Yes<sup><a href="#note-2">2</a></sup></td>
64-
<td>Configurable<sup><a href="#note-3">3</a></sup></td>
64+
<td><a href="#configure-ignore-issues">Configurable</a></td>
6565
<td>No</td>
6666
<td>Yes</td>
6767
<td>Yes</td>
@@ -71,7 +71,7 @@ Depending on your role on the Git provider you will have different permissions o
7171
<tr>
7272
<td>Repository Admin</td>
7373
<td>Yes<sup><a href="#note-2">2</a></sup></td>
74-
<td>Configurable<sup><a href="#note-3">3</a></sup></td>
74+
<td><a href="#configure-ignore-issues">Configurable</a></td>
7575
<td>Yes</td>
7676
<td>Yes</td>
7777
<td>Yes</td>
@@ -161,7 +161,7 @@ Depending on your role on the Git provider you will have different permissions o
161161
</tr>
162162
<tr>
163163
<td rowspan="2">Bitbucket Cloud and Bitbucket Server</td>
164-
<td>Read, Write<sup><a href="#note-4">4</a></td>
164+
<td>Read, Write<sup><a href="#note-3">3</a></td>
165165
<td>Yes<sup><a href="#note-2">2</a></sup></td>
166166
<td>No</td>
167167
<td>No</td>
@@ -185,7 +185,16 @@ Depending on your role on the Git provider you will have different permissions o
185185

186186
<sup id="note-1">1</sup>: Outside Collaborators and External Users aren't supported as Members of organizations on Codacy. However, you can [add them](managing-people.md#adding-people) so that Codacy analyzes their commits to private repositories.<br/>
187187
<sup id="note-2">2</sup>: Joining an organization may need an approval depending on your setting for [accepting new people](managing-people.md#joining).<br/>
188-
<sup id="note-3">3</sup>: Depending on your setting for [configuring which users can ignore issues](configuring-which-users-can-ignore-issues.md).<br/>
189-
<sup id="note-4">4</sup>: Codacy can't distinguish the Bitbucket roles Read and Write because of a limitation on the Bitbucket API.
188+
<sup id="note-3">3</sup>: Codacy can't distinguish the Bitbucket roles Read and Write because of a limitation on the Bitbucket API.
190189

191190
See [managing people](managing-people.md) to list and manage the members of your organization.
191+
192+
## Configuring who can ignore issues {: id="configure-ignore-issues"}
193+
194+
!!! info "Applies only to GitHub Cloud and GitHub Enterprise"
195+
196+
By default, only users with Admin permission on a repository can [ignore issues](../repositories/issues-view.md#ignoring-an-issue), but you can change this. In your Organization's settings, you can find **Members privileges** where you can define the lowest permission required to ignore issues for your organization.
197+
198+
![Configuring who can ignore issues](images/ignore-issues.png)
199+
200+
Codacy doesn't allow changing the role of a user, as the roles on Codacy are mirrored from your Git provider and applied to each repository.

docs/repositories/issues-view.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,15 @@ Each pattern has a pre-defined severity level and at the moment, it's not possib
2323

2424
## Ignoring an issue
2525

26-
For an issue you disagree with or false positives, you can either ignore that instance or disable the pattern across the whole repository. To do so, click on the cogwheel and select the desired option:
26+
You can ignore issues that you disagree with, either because they're not relevant or because you won't tackle them in the immediate future.
27+
28+
To do so, click on the cogwheel and select the desired option:
2729

2830
![Ignoring an issue](images/issues-view-ignore.gif)
2931

32+
!!! tip
33+
Organization owners can [configure who is allowed to ignore issues](../organizations/roles-and-permissions-for-synced-organizations.md#configure-ignore-issues).
34+
3035
### Reinstating ignored issues
3136

3237
To reinstate ignored issues, click on the **Current Issues** box, and select **Ignored Issues** from the drop-down menu.

mkdocs.yml

+4-4
Original file line numberDiff line numberDiff line change
@@ -278,8 +278,8 @@ plugins:
278278
"hc/en-us/articles/360012037659-GitLab-Integration.md": "repositories-configure/integrations/gitlab-integration.md"
279279
"hc/en-us/articles/360012056493.md": "release-notes/cloud/cloud-release-notes-|-02-november-2018.md"
280280
"hc/en-us/articles/360012056493-Cloud-Release-Notes-02-November-2018.md": "release-notes/cloud/cloud-release-notes-|-02-november-2018.md"
281-
"hc/en-us/articles/360012126419.md": "organizations/configuring-which-users-can-ignore-issues.md"
282-
"hc/en-us/articles/360012126419-How-to-configure-which-users-can-ignore-issues.md": "organizations/configuring-which-users-can-ignore-issues.md"
281+
"hc/en-us/articles/360012126419.md": "organizations/roles-and-permissions-for-synced-organizations.md"
282+
"hc/en-us/articles/360012126419-How-to-configure-which-users-can-ignore-issues.md": "organizations/roles-and-permissions-for-synced-organizations.md"
283283
"hc/en-us/articles/360012141513.md": "index.md"
284284
"hc/en-us/articles/360012141513-Scheduled-Maintenance-Saturday-17th-Nov-8-00-GMT-0-00-PST-.md": "index.md"
285285
"hc/en-us/articles/360012328140.md": "release-notes/cloud/removal-of-nodesecurity-golint-and-scsslint.md"
@@ -445,6 +445,7 @@ plugins:
445445
"related-tools/tool-developer-guide-using-scala.md": "related-tools/codacy-plugin-tools.md"
446446
"organizations/adding-and-managing-authors.md": "organizations/managing-people.md"
447447
"organizations/authors-vs-members.md": "organizations/managing-people.md"
448+
"organizations/configuring-which-users-can-ignore-issues.md": "organizations/roles-and-permissions-for-synced-organizations.md"
448449
# Moved pages
449450
"faq/general/plan-and-billing.md": "faq/general/how-can-i-change-or-cancel-my-plan.md"
450451
"organizations/why-can't-i-see-my-organization.md": "faq/general/why-cant-i-see-my-organization.md"
@@ -485,7 +486,7 @@ plugins:
485486
"related-tools/client-side-tools.md": "related-tools/local-analysis/client-side-tools.md"
486487
"related-tools/run-spotbugs.md": "related-tools/local-analysis/running-spotbugs.md"
487488
"repositories-configure/ignore-files-from-codacy-analysis.md": "repositories-configure/ignoring-files.md"
488-
"organizations/how-to-configure-which-users-can-ignore-issues.md": "organizations/configuring-which-users-can-ignore-issues.md"
489+
"organizations/how-to-configure-which-users-can-ignore-issues.md": "organizations/roles-and-permissions-for-synced-organizations.md"
489490
"repositories/what-are-the-different-grades-and-how-are-they-calculated.md": "faq/repositories/what-are-the-different-grades-and-how-are-they-calculated.md"
490491
"repositories/managing-branches.md": "repositories-configure/managing-branches.md"
491492
"repositories/quality-settings.md": "repositories-configure/quality-settings.md"
@@ -536,7 +537,6 @@ nav:
536537
- organizations/managing-repositories.md
537538
- organizations/managing-people.md
538539
- organizations/roles-and-permissions-for-synced-organizations.md
539-
- organizations/configuring-which-users-can-ignore-issues.md
540540
- Manual organizations (legacy):
541541
- organizations/manual-organizations/creating-and-renaming-an-organization.md
542542
- organizations/manual-organizations/creating-and-managing-teams.md

0 commit comments

Comments
 (0)