Merge branch 'task/58869309-alert-page' into 'release/2026.11.0'

amaksimovv · amaksimovv · commit 8c6890c55a2e · 2026-03-12T17:51:28.000+03:00
[2026.11.0] информация об алертах вынесена на отдельную страницу. Добавлено описание страницы алерта

See merge request CodeScoring/docs!631
diff --git a/docs/assets/img/alerts_page.png b/docs/assets/img/alerts_page.png
diff --git a/docs/assets/img/alerts_page_en.png b/docs/assets/img/alerts_page_en.png
diff --git a/docs/on-premise/how-to/policies.en.md b/docs/on-premise/how-to/policies.en.md
@@ -1,6 +1,6 @@
 ---
 hide:
-- footer
+  - footer
 ---
 
 # Managing policies
@@ -169,29 +169,3 @@ The policy becomes active immediately after creation by clicking the **Create**
 **Important**: policies are triggered during analysis, so it is important to create them before running the analysis.
 
 **Recommendation**: if you leave the `Proprietors`, `Groups` and `Projects` fields empty, the policy will apply to all active projects in the system.
-
-## Policy results
-
-The results of the policies are displayed in the `Policy alerts` section. The section has three tabs:
-
-- **Active** – a list of alerts based on the results of the last analysis (project, build or component in the proxy repository);
-- **Ignored** – a list of ignored alerts;
-- **Resolved** – a list of alerts that were resolved after the last analysis (the policy condition is no longer relevant).
-
-The policy trigger is displayed in the **Matched criteria** field, including the specified conditions and the component data found. For example, the value `django@4.2.2 has CVE-2024-38875, CVSS3 Score 7.5 >= 7.00` implies that the component blocking policy with CVSS3 equal to or higher than 7.00 was triggered on the django component version 4.2.2 with a vulnerability score of 7.5.
-
-To create a task or send an email from the list of alerts, you need to select one or more alerts and click the corresponding button.
-
-For example:
-
-- creating tasks
-
-![New task](/assets/img/alerts_new_task-en.png)
-
-- sending emails
-
-![Send email](/assets/img/alerts_send_email-en.png)
-
-Linked Jira issues can be unlinked using the bulk action `Delete the link to the issue`.
-
-![Remove issue link](/assets/img/alerts_remove_issue_link_en.png)
diff --git a/docs/on-premise/how-to/policies.md b/docs/on-premise/how-to/policies.md
@@ -169,29 +169,3 @@ hide:
 **Важно**: политики срабатывают во время анализа, поэтому важно их создать до запуска анализа.
 
 **Рекомендация**: если оставить поля `Подразделения`, `Группы` и `Проекты` пустыми, политика будет применяться для всех активных проектов в системе.
-
-## Результаты работы политик
-
-Результаты работы политик отображаются в разделе `Алерты`. Раздел имеет три вкладки:
-
-- **Активные** – список алертов по результатам последнего анализа (проекта, сборки или компонента в прокси-репозитории);
-- **Игнорированные** – список проигнорированных алертов;
-- **Решенные** – список алертов, которые были решены после последнего анализа (условие политики больше не актуально).
-
-Причина срабатывания политики отображается в поле **Условия политики**, включая заданные условия и найденные данные о компоненте. Например, значение `django@4.2.2 has CVE-2024-38875, CVSS3 Score 7.5 >= 7.00` подразумевает, что политика блокировки компонентов с CVSS3 равным или выше 7.00 сработала на компоненте django версии 4.2.2 с оценкой уязвимости 7.5.
-
-Для создания задачи или отправки email из списка алертов необходимо выбрать один или несколько алертов и нажать соответствующую кнопку.
-
-Например, так:
-
-- создание задач
-
-![New task](/assets/img/alerts_new_task.png)
-
-- отправка почтовых сообщений
-
-![Send email](/assets/img/alerts_send_email.png)
-
-Связанные задачи Jira можно отвязать, используя массовое действие `Удалить ссылку на задачу`.
-
-![Remove issue link](/assets/img/alerts_remove_issue_link.png)
diff --git a/docs/on-premise/how-to/policy-results.en.md b/docs/on-premise/how-to/policy-results.en.md
@@ -0,0 +1,55 @@
+---
+hide:
+  - footer
+---
+
+# Policy alerts
+
+## Policy alerts section
+
+Policy results are displayed in the `Policy alerts` section. The section has three tabs:
+
+- **Active** – a list of alerts based on the results of the last analysis (project, build, or component in the proxy repository);
+- **Ignored** – a list of ignored alerts;
+- **Resolved** – a list of alerts that were resolved after the last analysis (the policy condition is no longer relevant).
+
+The policy trigger is displayed in the **Matched criteria** field, including the specified conditions and the component data found. For example, the value `django@4.2.2 has CVE-2024-38875, CVSS3 Score 7.5 >= 7.00` implies that the component blocking policy with CVSS3 equal to or higher than 7.00 was triggered on the django component version 4.2.2 with a vulnerability score of 7.5.
+
+## Alert page
+
+The alert page opens when you click an alert in the list. The header shows the key fields:
+
+- **Is actual** – whether the alert is current;
+- **Policy** – the policy that triggered the alert (link to the policy page);
+- **Matched criteria** – matched conditions that caused the trigger;
+- **Level** – policy severity level;
+- **Stage** – policy stage;
+- **Blocker** – blocking policy flag;
+- **Created issues** – created tasks (for example, Jira);
+- **Sent emails** – email notification recipents.
+
+Related entities and details are displayed below, depending on the conditions that triggered the alert:
+
+- **Project**/**Container image**/**Package**/**Dependency** – component details and source (repository, tags, licenses);
+- **Related vulnerability** – short description, CVE, CVSS, and EPSS values;
+- **History** – alert timeline (creation time, ignore time, resolve time).
+
+![Policy alert page](/assets/img/alerts_page_en.png)
+
+## Alert actions
+
+To create a task or send an email from the alerts list, select one or more alerts and click the corresponding button.
+
+For example:
+
+- creating tasks
+
+![New task](/assets/img/alerts_new_task-en.png)
+
+- sending emails
+
+![Send email](/assets/img/alerts_send_email-en.png)
+
+Linked Jira issues can be unlinked using the bulk action `Delete the link to the issue`.
+
+![Remove issue link](/assets/img/alerts_remove_issue_link_en.png)
diff --git a/docs/on-premise/how-to/policy-results.md b/docs/on-premise/how-to/policy-results.md
@@ -0,0 +1,55 @@
+---
+hide:
+  - footer
+---
+
+# Алерты политик
+
+## Раздел «Алерты»
+
+Результаты работы политик отображаются в разделе `Алерты`. Раздел имеет три вкладки:
+
+- **Активные** – список алертов по результатам последнего анализа (проекта, сборки или компонента в прокси-репозитории);
+- **Игнорированные** – список проигнорированных алертов;
+- **Решенные** – список алертов, которые были решены после последнего анализа (условие политики больше не актуально).
+
+Причина срабатывания политики отображается в поле **Условия политики**, включая заданные условия и найденные данные о компоненте. Например, значение `django@4.2.2 has CVE-2024-38875, CVSS3 Score 7.5 >= 7.00` подразумевает, что политика блокировки компонентов с CVSS3 равным или выше 7.00 сработала на компоненте django версии 4.2.2 с оценкой уязвимости 7.5.
+
+## Карточка алерта
+
+Карточка алерта открывается по клику на алерт в списке. В верхней части страницы отображаются ключевые поля:
+
+- **Актуальный** – актуальность алерта;
+- **Политика** – политика, по которой сработал алерт (ссылка на карточку политики);
+- **Условия политики** – совпавшие критерии, из-за которых сработала политика;
+- **Уровень** – уровень критичности политики;
+- **Этап** – стадия, на которой сработала политика;
+- **Блокер** – признак блокирующей политики;
+- **Созданные задачи** – список созданных задач (например, Jira);
+- **Отправленные письма** – список получателей отправленных email-уведомлений.
+
+Ниже показывается информация о связанных сущностях и детали, в зависимости от условий, с которыми сработал алерт:
+
+- **Проект**/**Контейнерный образ**/**Пакет**/**Зависимость** – информация о компоненте и источнике (репозиторий, теги, лицензии);
+- **Связанная уязвимость** – краткое описание, CVE, оценки CVSS и EPSS;
+- **История** – события по алерту (время создания, время игнора, время решения).
+
+![Policy alert page](/assets/img/alerts_page.png)
+
+## Действия с алертами
+
+Для создания задачи или отправки email из списка алертов необходимо выбрать один или несколько алертов и нажать соответствующую кнопку.
+
+Например, так:
+
+- создание задач
+
+![New task](/assets/img/alerts_new_task.png)
+
+- отправка почтовых сообщений
+
+![Send email](/assets/img/alerts_send_email.png)
+
+Связанные задачи Jira можно отвязать, используя массовое действие `Удалить ссылку на задачу`.
+
+![Remove issue link](/assets/img/alerts_remove_issue_link.png)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -105,6 +105,7 @@ plugins:
           general-intro: "General"
           policies: "Security policies"
           policies-settings: "Managing policies"
+          policies-results: "Policy results"
           artifact-plugins: "Plugins for repositories"
           repo-managers: "Connecting a repository manager"
           registries: "Connecting a container registry"
@@ -269,6 +270,7 @@ plugins:
           general-intro: "Общее"
           policies: "Политики безопасности"
           policies-settings: "Настройка политик"
+          policies-results: "Результаты работы политик"
           artifact-plugins: "Плагины для хранилищ"
           repo-managers: "Подключение менеджера репозиториев"
           registries: "Подключение реестра с образами"
@@ -482,6 +484,8 @@ nav:
         - policies-settings: on-premise/how-to/policies.en.md
         - ignores: on-premise/how-to/ignores.md
         - ignores: on-premise/how-to/ignores.en.md
+        - policies-results: on-premise/how-to/policy-results.md
+        - policies-results: on-premise/how-to/policy-results.en.md
       - project-setup:
         - vcs: on-premise/how-to/vcs-git.md
         - vcs: on-premise/how-to/vcs-git.en.md
