GITBOOK-9116: ao, CCI style guide review

Author: andreionciu

docs/SUMMARY.md

@@ -717,7 +717,7 @@
     * [Ignore issues](manage-risk/prioritize-issues-for-fixing/ignore-issues/README.md)
       * [How ignores work for Projects imported using an SCM and the CLI](manage-risk/prioritize-issues-for-fixing/ignore-issues/how-ignores-work-for-projects-imported-using-an-scm-and-the-cli.md)
       * [Exclude files and ignore issues FAQs](manage-risk/prioritize-issues-for-fixing/ignore-issues/exclude-files-and-ignore-issues-faqs.md)
-      * [Consistent Ignores for Snyk Code Early Access](manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/README.md)
+      * [Consistent Ignores for Snyk Code](manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/README.md)
         * [Consistent Ignores for Snyk Code API](manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/api.md)
         * [Consistent Ignores for Snyk Code CLI](manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/snyk-cli.md)
         * [Consistent Ignores for Snyk Code IDE](manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/snyk-ide.md)

docs/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/README.md

@@ -5,12 +5,10 @@
 
 Snyk Code Consistent Ignores is in Early Access and available only with Enterprise plans. For more information, see [plans and pricing](https://snyk.io/plans/).
 
-To make sure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
+To ensure Consistent Ignores meets your needs and requirements, review the [FAQ](consistent-ignores-for-snyk-code-faqs.md) section.
 {% endhint %}
 
-Snyk Code Consistent Ignores helps your teams focus on important tasks by filtering out distractions. 
-
-It makes sure that once an ignore is created, it is consistently respected regardless of how and where the test is run and what branch is being tested. 
+Snyk Code Consistent Ignores helps your teams focus on important tasks by filtering out distractions. It ensures that once an ignore is created, it is consistently respected regardless of how and where the test is run and what branch is being tested. 
 
 By filtering out false positives, inapplicable threats, and accepted risks, your security teams can prioritize fixing real problems, and developers can code without interruptions. 
 
@@ -39,9 +37,9 @@ To create, edit and remove ignores, you need to have a user role assigned with I
 
 ## Convert Project-scoped ignores to asset-scoped ignores
 
-{% hint style="info" %}
-**Before you begin**
+### Conversion setup
 
+{% hint style="info" %}
 If you're new to Snyk or with Snyk Code Projects, you can skip this step as there are no existing ignores to be converted.
 {% endhint %}
 
@@ -63,9 +61,9 @@ To convert the issue from a Project-scoped to an asset-scoped ignore, select **I
 
 You can manage ignores proactively using group-level Snyk Code security policies. As a general rule, you can apply ignore policies when you identify a recurring need to apply similar individual ignores. 
 
-To manage the ignores through security policies, Snyk Code Consistent Ignores need to be enabled at the Group level by your Snyk team. You will not require [conversion](./#convert-project-scoped-ignores-to-asset-scoped-ignores) for any previously applied Group level policy ignores.
+To manage the ignores through security policies, Snyk Code Consistent Ignores need to be enabled at the Group level by your Snyk team. You do not require [conversion](./#convert-project-scoped-ignores-to-asset-scoped-ignores) for any previously applied Group level policy ignores.
 
-Policies configured to ignore based Project attributes will not result in ignores being applied in Snyk CLI and IDE settings where a Snyk Project is not available.
+Policies configured to ignore-based Project attributes do not result in ignores being applied in Snyk CLI and IDE settings where a Snyk Project is not available.
 
 | Criteria | Description                                                                                                                                                                                                                                                      |
 | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -76,15 +74,11 @@ Policies configured to ignore based Project attributes will not result in ignore
 
 You can take action from Project issues, but Snyk will apply any ignores to the underlying asset-scoped findings that can span across Snyk Projects, integrations, and branches.
 
-{% hint style="info" %}
-**Before you begin**
-
 When you create, modify, or delete an ignore, you must [retest the Project](../../../../scan-with-snyk/snyk-code/manage-code-vulnerabilities/#retesting-code-repository) to update the issue status. 
 
 An indicator at the top of the Project page will notify you if a retest is needed to capture policy or ignore updates. 
 
 Project retests typically occur on a nightly or weekly basis, but you can also retest manually.
-{% endhint %}
 
 ### Create ignore
 

docs/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/api.md

@@ -1,15 +1,15 @@
-# API
+# Consistent Ignores for Snyk Code API
 
 {% hint style="info" %}
 **Release status**
 
 Snyk Code Consistent Ignores is in Early Access and available only with Enterprise plans. For more information, see [plans and pricing](https://snyk.io/plans/).
 
-To make sure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
+To ensure Consistent Ignores meets your needs and requirements, review the [FAQ](consistent-ignores-for-snyk-code-faqs.md) section.
 {% endhint %}
 
 You can manage ignores individually through the [Snyk Policies API (REST)](https://apidocs.snyk.io/version=2024-10-14~experimental?version=2024-10-15#get-/orgs/-org_id-/policies). 
 
 The SARIF output from Snyk CLI contains the `snyk/asset/finding/v1` identifier used to manage ignores at the start of the Early Access program. 
 
-This API leverages the `snyk/asset/finding/v1` identifier and not the `issueId` used by the legacy ignores API. You should prepare to migrate any scripts or automation that rely on the legacy ignores API to the new policy API.
+This API leverages the `snyk/asset/finding/v1` identifier and not the `issueId` used by the legacy ignores API. Consider migrating any scripts or automation that rely on the legacy ignores API to the new policy API.

docs/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/consistent-ignores-for-snyk-code-faqs.md

@@ -4,11 +4,47 @@
 **Release status**
 
 Snyk Code Consistent Ignores is in Early Access and available only with Enterprise plans. For more information, see [plans and pricing](https://snyk.io/plans/).
-
-To make sure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
 {% endhint %}
 
-This FAQ section addresses common concerns about the Snyk Code Consistent Identity Early Access program. You can share feedback with your Snyk account team about these items. Snyk will consider all suggestions but implementation or addressing these issues is not guaranteed for the upcoming GA version.
+This FAQ section addresses common concerns about the Snyk Code Consistent Identity Early Access program. You can share feedback about these items with your Snyk account team. 
+
+## Snyk Code CLI Upload 
+
+Snyk Code Consistent Ignores does not support ignores for Projects associated with CLI Upload. 
+
+If you activate a Snyk Organization with Snyk Code CLI Upload Projects, ignores for any subsequent scans using `snyk code test --report` are not taken into account. All resulting Projects and associated issues are shown as open. Additionally, any pre-existing [Project-scoped ignores will not be converted to asset-scoped ignores](./#convert-project-scoped-ignores-to-asset-scoped-ignores). 
+
+<figure><img src="../../../../.gitbook/assets/Ignored-issue-using-legacy-system.png" alt=""><figcaption><p>Snyk Code Consistent Ignores limitation in CLI upload</p></figcaption></figure>
+
+### Recommendation
+
+If you're using Snyk Code CLI Upload Projects, consider postponing Consistent Ignores enablement until these workflows are supported.
+
+If you want to try out Snyk Code Consistent Ignores, you can enable it for Organizations that do not have Snyk Code CLI Upload Projects.
+
+## Finding identifier added to Issues API and Reporting&#x20;
+
+There are no changes to the [Group](https://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org_id-/issues) and [Organization](https://apidocs.snyk.io/?version=2024-10-15#get-/orgs/-org_id-/issues) level Issues API endpoints or Reporting (issue reporting).
+
+An additional attribute containing the finding identifier will be added to these API endpoints and issue reports in the coming months. You can use this to assist you in converting from Project-scoped to asset-scoped ignores, especially at scale or if you have competing ignores across different Projects.
+
+## Bulk ignore conversion
+
+You need to migrate pre-existing Project-scoped ignores to asset-scoped ignores manually on the Projects page.
+
+You may be able to script some of the migration using the CLI, as the CLI output returns both the `issueId` value used in the v1 ignores API, and the `snyk/assets/finding/v1` ID used to manage asset-scoped ignores. The bulk ignore conversion needs to be done at the repository level.&#x20;
+
+### Recommendation
+
+If you need support with the migration, reach out to your Snyk account teams or request time with Snyk product management to share feedback on what will make this process easier for you.
+
+### Support for Bitbucket Data Center/Server <a href="#support-for-bitbucket-data-center-server" id="support-for-bitbucket-data-center-server"></a>
+
+When testing a Bitbucket Server repository, the ignores created are not respected across Projects imported through an SCM integration, Snyk CLI, and IDE.
+
+#### Recommendation <a href="#recommendation-2" id="recommendation-2"></a>
+
+Postpone activating Snyk Code Consistent Ignores until Bitbucket Data Center/Server is fully supported.
 
 ## Ignore limitations outside my Snyk Organization
 
@@ -18,7 +54,7 @@ Depending on feedback during the Early Access period, we may offer a broader sco
 
 ## Existing DeepCode inline ignores (legacy) are not supported or migrated
 
-Deepcode inline ignores are a legacy feature that is only available for certain customers. If you have pre-existing Deepcode inline ignores, Snyk will remove them from test results. They will not be marked as `Open` or `Ignored`.
+Deepcode inline ignores are a legacy feature that is only available for certain customers. If you have pre-existing Deepcode inline ignores, Snyk removes them from the test results. The results are not marked as `Open` or `Ignored`.
 
 ### Recommendation
 
@@ -39,7 +75,7 @@ Snyk may fail to complete testing after you rename a repository, depending on wh
 1. Delete all targets associated with that repository.
 2. Reimport the newly renamed repository.
 
-Previous Consistent Ignores will apply to the newly named repository. New clones in IDEs/CLI that reference the new name will also take into account ignores, even with the old git URL, in case some developers haven't updated their remote repositories.
+Previous Consistent Ignores are applied to the newly named repository. New clones in IDEs/CLI that reference the new name take into account the ignores, even with the old git URL, in case some developers haven't updated their remote repositories.
 
 ## Granular ignores
 
@@ -49,7 +85,7 @@ If you have specific use cases that require this functionality, reach out to you
 
 ## Project attribute policies
 
-Policies defined against Project attributes will continue to work within Snyk Projects where the attributes match. However, they will not apply across the repository to other Projects or in Snyk IDE, CLI, or PR checks flows. To apply policies across Projects and branches for the same repository, define them against Organizations.
+Policies defined against Project attributes will continue to work within Snyk Projects where the attributes match. The policies are not applied across the repository to other Projects or in Snyk IDE, CLI, or PR checks flows. To apply policies across Projects and branches for the same repository, define them against Organizations.
 
 ## CI/CD support for snyk test --code
 

docs/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/known-limitations.md

@@ -1,11 +1,15 @@
+---
+hidden: true
+---
+
 # Known limitations
 
 {% hint style="info" %}
 **Release status**
 
 Snyk Code Consistent Ignores is in Early Access and available only with Enterprise plans. For more information, see [plans and pricing](https://snyk.io/plans/).
 
-To make sure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
+To ensure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review the [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
 {% endhint %}
 
 The following items are planned to be delivered in the months following the Early Access program.

docs/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/snyk-cli.md

@@ -5,7 +5,7 @@
 
 Snyk Code Consistent Ignores is in Early Access and available only with Enterprise plans. For more information, see [plans and pricing](https://snyk.io/plans/).
 
-To make sure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
+To ensure Consistent Ignores meets your needs and requirements, review the [FAQ](consistent-ignores-for-snyk-code-faqs.md) section.
 {% endhint %}
 
 Ignores are taken into account in the Snyk CLI when `snyk code test` is run.
@@ -32,9 +32,9 @@ The CLI display output hides ignored results by default when you run `snyk code
 
 ## View ignores in Snyk CLI
 
-After running `snyk code test`, the CLI will display a hint about using the `--include-ignores` parameter to show ignored results.
+After running `snyk code test`, the CLI displays a hint about using the `--include-ignores` parameter to show ignored results.
 
-Running `snyk code test --include-ignores` will display ignored results with their metadata below the open results.
+Running `snyk code test --include-ignores` shows ignored results with their metadata below the open results.
 
 <figure><img src="../../../../.gitbook/assets/display-ignores-snyk-cli.png" alt=""><figcaption><p>Ignores in Snyk CLI</p></figcaption></figure>
 

docs/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/snyk-ide.md

@@ -5,7 +5,7 @@
 
 Snyk Code Consistent Ignores is in Early Access and available only with Enterprise plans. For more information, see [plans and pricing](https://snyk.io/plans/).
 
-To make sure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
+To ensure Consistent Ignores meets your needs and requirements, review the [FAQ](consistent-ignores-for-snyk-code-faqs.md) section.
 {% endhint %}
 
 When you run tests in any of the [four supported Snyk IDE plugins](../../../../scm-ide-and-ci-cd-integrations/snyk-ide-plugins-and-extensions/), the plugins will take into account your ignores.
@@ -31,6 +31,6 @@ The IDE display output hides ignored results by default to maintain developer fo
 
 ## View ignores in Snyk IDE
 
-You can apply filters in the plugin settings to show ignored results alongside open results or in isolation. When you set ignored issues to display, the issues and their details will appear in the plugin.
+You can apply filters in the plugin settings to show ignored results alongside open results or in isolation. When you set ignored issues to display, the issues and their details appear in the plugin.
 
 <figure><img src="../../../../.gitbook/assets/snyk-code-ignored-issue-ide.png" alt=""><figcaption><p>View ignores in Snyk IDE</p></figcaption></figure>

docs/manage-risk/prioritize-issues-for-fixing/ignore-issues/consistent-ignores-for-snyk-code-early-access/snyk-pull-request-checks.md

@@ -1,22 +1,22 @@
-# Snyk Pull Request Checks
+# Consistent Ignores for Snyk Code Pull Request Checks
 
 {% hint style="info" %}
 **Release status**
 
 Snyk Code Consistent Ignores is in Early Access and available only with Enterprise plans. For more information, see [plans and pricing](https://snyk.io/plans/).
 
-To make sure Snyk Code Consistent Ignores Early Access meets your needs and requirements, review [Known limitations](known-limitations.md) and [FAQ](consistent-ignores-for-snyk-code-faqs.md) sections.
+To ensure Consistent Ignores meets your needs and requirements, review the [FAQ](consistent-ignores-for-snyk-code-faqs.md) section.
 {% endhint %}
 
 ## Pull Request Check default ignore behavior
 
-When viewing a pull request (PR) check from Snyk in your integrated SCM, ignored findings do not contribute to the PR check outcome. A PR check will not fail due to an ignored finding. Additionally, the Snyk PR experience will include the count of active (unignored) findings in the summary comment and display each finding as an inline comment within the PR.
+When viewing a pull request (PR) check from Snyk in your integrated SCM, ignored findings do not contribute to the PR check outcome. A PR check does not fail due to an ignored finding. Additionally, the Snyk PR experience includes the count of active (unignored) findings in the summary comment and displays each finding as an inline comment within the PR.
 
-If a finding is ignored after a PR check has already been completed, the PR check must be retriggered by committing again to the PR. Upon retriggering, the PR check the following changes will occur:
+If a finding is ignored after a PR check has already been completed, the PR check must be retriggered by committing again to the PR. Upon retriggering, the PR check the following changes occur:
 
-• The ignored finding will no longer be counted in the summary table.
+• The ignored finding is no longer counted in the summary table.
 
-• The inline comment for the ignored finding will be collapsed by default and marked as resolved.
+• The inline comment for the ignored finding is collapsed by default and marked as resolved.
 
 Ignores are respected in[ Snyk Code Pull Request Checks](../../../../scan-with-snyk/pull-requests/pull-request-checks/) regardless of whether they are created through [policy](./#manage-ignores-at-the-group-level-through-security-policies) or for an [individual `snyk/assets/finding/v1` value](./#manage-ignores-in-snyk-projects).
 
@@ -36,6 +36,6 @@ Before being ignored, the finding appears as an inline comment in your SCM integ
 
 <figure><img src="../../../../.gitbook/assets/finding-before-ignore.png" alt=""><figcaption><p>PR check ignored finding details in GitHub </p></figcaption></figure>
 
-After an ignore is applied, and a PR check is re-triggered, the inline comment for the ignored finding is collapsed by default and marked as resolved.&#x20;
+After an ignore is applied and a PR check is re-triggered, the inline comment for the ignored finding is collapsed by default and marked as resolved.&#x20;
 
 <figure><img src="../../../../.gitbook/assets/finding-after-ignored-collapsed-view.png" alt=""><figcaption><p>Collapsed view of a finding in Github</p></figcaption></figure>