Skip to content

Commit d4eedeb

Browse files
AvtandilkoNikita VelginLada7878
authored
add kanban widget description (#217)
* add kanban widget description * quote Signed-off-by: lada7878 <ladalada7878@gmail.com> --------- Signed-off-by: lada7878 <ladalada7878@gmail.com> Co-authored-by: Nikita Velgin <nikita.velgin@flant.com> Co-authored-by: lada7878 <ladalada7878@gmail.com>
1 parent 682a3c2 commit d4eedeb

2 files changed

Lines changed: 35 additions & 11 deletions

File tree

content/documentation/admin/widgets/types.ru.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ title: Типы виджетов
8383

8484
| Название | Обязательность | Описание | Пример |
8585
|---------------------------|-----------------|----------------------------------------------------------|------------------------------------------------------------------------|
86-
| Ключ проекта | Да | Часть URL репозитория, которая идёт сразу после **/projects/** | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `MYTEAM` |
87-
| Идентификатор репозитория | Да | Часть URL репозитория, которая идёт сразу после **/repos/** | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `backend` |
86+
| Ключ проекта | Да | Часть URL репозитория, которая идёт сразу после `/projects/` | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `MYTEAM` |
87+
| Идентификатор репозитория | Да | Часть URL репозитория, которая идёт сразу после `/repos/` | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `backend` |
8888

8989
#### Фильтрация по статусу
9090

@@ -557,10 +557,10 @@ title: Типы виджетов
557557

558558
#### Конфигурация
559559

560-
| Название | Обязательность | Описание | Пример |
561-
|--------------|-----------------|-----------------------------------------------------------------|------------------------------------------------------------------------|
562-
| Ключ проекта | Да | Часть URL репозитория, которая идёт сразу после **/projects/** | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `MYTEAM` |
563-
| Репозиторий | Да | Часть URL репозитория, которая идёт сразу после **/repos/** | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `backend` |
560+
| Название | Обязательность | Описание | Пример |
561+
|--------------|-----------------|------------------------------------------------------------|------------------------------------------------------------------------|
562+
| Ключ проекта | Да | Часть URL репозитория, которая идёт сразу после `/projects/` | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `MYTEAM` |
563+
| Репозиторий | Да | Часть URL репозитория, которая идёт сразу после `/repos/` | Для репозитория `.../projects/MYTEAM/repos/backend` укажите `backend` |
564564

565565
#### Отображаемые данные
566566

@@ -1369,17 +1369,40 @@ sum(ingress_nginx_detail_requests_total)
13691369
| Ресурс | Нет | Ресурс, из которого извлекаются необходимые значения при обработке шаблона | - |
13701370
| Процентное значение | Нет | Значение, которое будет выводиться на виджет. Шаблонизация поддерживается. Пример без шаблонизации: `100`. Пример с шаблонизацией: `{{ .entity.properties.id }}` | - |
13711371

1372-
### Таблицы сущностей
1372+
### Таблица сущностей
13731373

13741374
Виджет позволяет отображать сущности, созданные в DDP, в виде таблицы.
13751375

13761376
#### Конфигурация
13771377

1378-
| Название | Обязательность | Описание | Значение по умолчанию |
1379-
|---------------------|----------------|-----------------------------------------------------------------------------------------------------------------------|-----------------------|
1380-
| Источник | Нет | Сущности, которые необходимо отобразить в виде таблицы | - |
1378+
| Название | Обязательность | Описание | Значение по умолчанию |
1379+
|---------------------|----------------|------------------------------------------------------------------------------------------------------------------------|-----------------------|
1380+
| Ресурс | Да | Ресурс, сущности которого отображаются в таблице | - |
13811381
| Показывать действия | Нет | Необходимость отображения действий с сущностями (возможность запуска действий и сценариев, возможность удаления и др.) | false |
13821382

1383+
### Kanban доска сущностей
1384+
1385+
Виджет отображает сущности выбранного ресурса на Kanban-доске.
1386+
1387+
#### Отображаемые данные
1388+
1389+
- «Колонки» — настроенные колонки доски и колонка «Без статуса» для сущностей без подходящего значения параметра состояния.
1390+
- «Карточки сущностей» — для каждой сущности отображаются название, описание (если указано), статус проверок, владелец и дата обновления.
1391+
- «Перемещение карточек» — перетаскивание карточки между колонками обновляет значение параметра состояния сущности (доступно при наличии прав на изменение сущностей).
1392+
1393+
#### Конфигурация
1394+
1395+
| Название | Обязательность | Описание | Значение по умолчанию |
1396+
|----------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|
1397+
| Ресурс | Да | Ресурс, сущности которого отображаются на доске | - |
1398+
| Параметр состояния | Да | Параметр сущности, определяющий колонку карточки. Поддерживаются типы `String`, `Number`, `Boolean`, `Enum`, `List`, `Date`, `Percentage`, `URL` | - |
1399+
| Колонки | Да | Список колонок доски. Для каждой колонки задаются: название (заголовок на доске), значение (значение параметра состояния; для параметров типа `Enum` и `List` выбирается из доступных опций) и цвет (цвет тега в заголовке). Порядок колонок настраивается перетаскиванием | - |
1400+
1401+
#### Особенности
1402+
1403+
- Сущности без подходящего значения параметра состояния отображаются в колонке «Без статуса».
1404+
- При отсутствии прав на изменение сущностей перемещение карточек недоступно.
1405+
13831406
### Временная шкала сущностей
13841407

13851408
Виджет отображает сущности выбранного ресурса на временной шкале.

content/documentation/release-notes/v1.6.0.ru.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ description: Заметки о выпуске v1.6.0 — выгрузка ауд
2929

3030
### Виджеты
3131

32-
Добавлен виджет [«DefectDojo. Продукт»](../../admin/widgets/types/#defectdojo-продукт) для просмотра уязвимостей продукта в DefectDojo с разбивкой по engagement и уровням критичности.
32+
- Добавлен виджет [«DefectDojo. Продукт»](../../admin/widgets/types/#defectdojo-продукт) для просмотра уязвимостей продукта в DefectDojo с разбивкой по engagement и уровням критичности.
33+
- Добавлен виджет [«Kanban доска сущностей»](../../admin/widgets/types/#kanban-доска-сущностей) для отображения сущностей ресурса на Kanban-доске.
3334

3435
### Наборы данных
3536

0 commit comments

Comments
 (0)