process store docs (#222)

* process store docs

* fix lint

* fix

---------

Co-authored-by: Nikita Velgin <nikita.velgin@flant.com>

Author: Avtandilko

.werf/nginx-local.conf

@@ -50,8 +50,8 @@ http {
     }
 
     map $lang $hugo_upstream {
-        "ru"    "hugo_1314";
-        default "hugo_1313";
+        "ru"    "hugo_1313";
+        default "hugo_1314";
     }
     map $host $publicdocupstream {
         hostnames;

content/documentation/admin/actions/overview.ru.md

@@ -243,16 +243,20 @@ project_id: {{ .property.project_id }}
 
 #### Обновление хранилища процесса
 
-Правила из раздела «Обновление хранилища процесса» применяются только при выполнении действия в рамках процесса: если они заданы, то после успешного выполнения действия значения по этим правилам записываются в хранилище.
+Правила из раздела «Обновление хранилища процесса» применяются только при выполнении действия в рамках процесса: после успешного завершения действия значения записываются в хранилище запуска по заданным правилам, **в порядке списка**.
 
-| Поле               | Описание                                                                 |
-| ------------------ | ------------------------------------------------------------------------ |
-| Источник           | Go-шаблон значения                                                       |
-| Ключ в хранилище   | Ключ, под которым значение сохраняется в хранилище процесса              |
+| Поле | Описание |
+| ---- | -------- |
+| Условие | Необязательный Go-шаблон; пустое — правило всегда выполняется. Результат рендеринга: `true`, `false`, `1` или `0` |
+| Операция | Записать строку, Записать JSON, Добавить строку, Добавить JSON, Слить JSON (поверхностно), Удалить |
+| Цель | Dot-path в хранилище без ведущей точки, например `deploy.job_id` или `notification.items` |
+| Источник | Go-шаблон значения |
 
-Другие действия в процессе могут читать сохранённое значение через шаблон `{{ .store.key }}`, где `key` — указанный ключ.
+Другие действия и элементы процесса читают данные через `{{ .store.<путь> }}`. Внутри цикла в шаблонах доступен контекст `{{ .store._loop.* }}`.
 
-Если правил нет (список пустой), при выполнении действия в процессе в хранилище ничего не записывается. Данные из хранилища можно использовать в последующих действиях того же процесса через плейсхолдеры `{{ .store.<ключ> }}`. Подробности описаны в разделе [«Хранилище процесса»](../processes/#хранилище-процесса).
+Если правил нет (список пустой), при выполнении действия в процессе в хранилище ничего не записывается.
+
+Подробное описание операций, примеры правил, цикл по коллекции и просмотр хранилища — в разделе [«Хранилище процесса»](../processes/store/).
 
 ### Безопасность
 

content/documentation/admin/processes/_index.ru.md

@@ -0,0 +1,4 @@
+---
+title: Процессы
+weight: 35
+---

…tent/documentation/admin/processes.ru.md …mentation/admin/processes/overview.ru.mdcontent/documentation/admin/processes.ru.md renamed to content/documentation/admin/processes/overview.ru.md content/documentation/admin/processes.ru.md renamed to content/documentation/admin/processes/overview.ru.md

@@ -1,6 +1,6 @@
 ---
-title: Процессы
-menuTitle: Процессы
+title: Обзор
+weight: 10
 ---
 
 Процессы — это механизм автоматизации сложных бизнес-сценариев, который позволяет создавать визуальные схемы выполнения действий с поддержкой условной логики, параллельного выполнения и обработки ошибок.
@@ -15,7 +15,8 @@ menuTitle: Процессы
 * «Задача» — выполнение конкретного действия.
 * «Эксклюзивный шлюз» — условное ветвление.
 * «Параллельный шлюз» — объединение нескольких веток процесса в одну.
-* «Цикл» — повторение части процесса заданное число раз.
+* «Цикл» — повторение части процесса фиксированное число раз или обход JSON-массива из хранилища.
+* «Шаблон» — вычисление Go-шаблона и запись результата в хранилище процесса.
 * «Примечание» — текстовый блок.
 * «Ошибка» — немедленная остановка процесса со статусом `Failed`.
 * «Конец» — завершение процесса.
@@ -60,10 +61,11 @@ menuTitle: Процессы
 
 Эксклюзивный шлюз позволяет настраивать ветвление процесса по условиям. По умолчанию проверяется статус предыдущей задачи, и в зависимости от него выполнение идёт по «успешной» или «неуспешной» ветке.
 
-В качестве условий для эксклюзивного шлюза можно задать либо проверку статуса предыдущей задачи, либо проверку параметра из хранилища процесса:
+В качестве условий для эксклюзивного шлюза можно задать либо проверку статуса предыдущей задачи, либо сравнение значений из шаблонов:
 
-- Для проверки статуса предыдущей задачи используйте конструкцию `{{ .prev_task.status }}`
-- Для проверки значения переменной из хранилища используйте конструкцию `{{ .store.<название переменной> }}`.
+- Для проверки статуса предыдущей задачи используйте конструкцию `{{ .prev_task.status }}`.
+- Для проверки значения из хранилища — `{{ .store.<путь> }}`, в том числе вложенные ключи: `{{ .store.notification.status }}`.
+- Внутри цикла — поля текущего элемента: `{{ .store._loop.item.scan_type }}`, флаги `{{ .store._loop.first }}` и `{{ .store._loop.last }}`.
 
 Доступна проверка нескольких условий с комбинацией их результатов через оператор `AND` или `OR`.
 
@@ -86,21 +88,43 @@ menuTitle: Процессы
 
 ##### Цикл
 
-Элемент «Цикл» предназначен для выполнения одной и той же части процесса заданное число раз, после выполнения активируется элемент, подключенный к выходу из цикла.
+Элемент «Цикл» повторяет ветку процесса либо фиксированное число раз, либо по каждому элементу JSON-массива из хранилища. После завершения всех итераций активируется элемент, подключённый к выходу из цикла.
 
-В конфигурации цикла можно настроить количество итераций: от 1 до 10000.
+###### Режим цикла
+
+- **Фиксированное число** — поле «Количество итераций» от 1 до 10000. На каждой итерации в `{{ .store._loop.item }}` доступен номер итерации (1, 2, 3…).
+- **По коллекции** — поле «Шаблон коллекции»: Go-шаблон, который при входе в цикл должен дать JSON-массив. Обычно указывают путь к массиву, записанному предыдущей задачей: `{{ .store.notification.engagements }}`. Каждый элемент массива — одна итерация; текущий элемент доступен как `{{ .store._loop.item }}`.
+
+Если массив пуст или ключ отсутствует, тело цикла не выполняется, процесс сразу переходит по связи «Выход из цикла».
+
+Подробнее — в разделе [«Хранилище процесса»](store/#цикл-по-коллекции-из-хранилища).
 
 ###### Исходящие связи
 
 Из элемента «Цикл» должны выходить ровно две связи к разным элементам:
-- «Тело цикла» — нижний порт; от него строится ветка, которая выполняется на каждой итерации.
-- «Выход из цикла» — правый порт; по этой ветке выполнение продолжается после последней итерации.
+
+1. «Тело цикла» — нижний порт; от него строится ветка, которая выполняется на каждой итерации.
+1. «Выход из цикла» — правый порт; по этой ветке выполнение продолжается после последней итерации.
 
 ###### Использование
 
-Элемент «Цикл» можно ставить после «Эксклюзивного шлюза» или «Параллельного шлюза», если нужно повторять выбранную ветку, либо использовать для схем, где один блок шагов должен пройти фиксированное число раз.
+Типовые сценарии:
+
+- повторная проверка статуса внешней системы с фиксированным числом попыток;
+- обход списка объектов из ответа API: задача записывает массив в хранилище, цикл в режиме «По коллекции» обрабатывает каждый элемент;
+- вложенные циклы — контекст родителя доступен через `{{ .store._loop.parent }}`.
+
+##### Шаблон
 
-Типовой пример использования: ожидание в теле цикла успешного выполнения какой-либо длительной операции и выход через эксклюзивный шлюз при положительном результате проверки, либо возврат в цикл при отрицательном результате.
+Элемент «Шаблон» вычисляет Go-шаблон без дополнительного вызова действия и записывает результат в хранилище как строку.
+
+Настройте:
+
+- «Тело шаблона» — текст с плейсхолдерами `{{ .store.* }}`, `{{ .process.* }}`, внутри цикла — `{{ .store._loop.* }}`;
+- «Ключ в хранилище» — dot-path назначения, например `rendered_message`;
+- «Подсказка формата» — как отображать значение при просмотре запуска (`text`, `markdown`, `html`, `json`); не влияет на содержимое хранилища.
+
+Примеры и ограничения — в разделе [«Хранилище процесса»](store/#элемент-шаблон).
 
 ##### Таймер
 
@@ -154,30 +178,22 @@ menuTitle: Процессы
 
 На вкладке `Параметры` настраиваются параметры процесса, которые могут использоваться во всех действиях процесса.
 
-Конфигурация и использование параметров процесса описаны в разделе [«Шаблонизация»](../user/templating/#параметры-процесса).
+Конфигурация и использование параметров процесса описаны в разделе [«Шаблонизация»](../../user/templating/#параметры-процесса).
 
 ### Хранилище процесса
 
-Хранилище процесса — это хранилище в формате «ключ — значение» для передачи данных между действиями в процессе.
-
-#### Основные характеристики
-
-- «Одно хранилище на запуск процесса» — каждый запуск процесса имеет своё хранилище.
-- «Плоские ключи» — в хранилище используются только логические ключи (например `projectId`, `deployJobId`).
-- «Запись только по правилам» — в хранилище записывается только то, что задано в настройках действий, входящих в процесс (см. [«Обновление хранилища процесса»](../actions/overview/#обновление-хранилища-процесса)). Если правил записи нет — в хранилище ничего не записывается.
-- «Чтение через плейсхолдеры» — в конфигурации действий (URL, заголовки, body и т. д.) можно использовать Go-шаблоны вида `{{ .store.<ключ> }}` (см. [«Хранилище процесса»](../../user/templating/#хранилище-процесса)).
-
-#### Как данные попадают в хранилище
+Хранилище процесса — JSON-объект для передачи данных между шагами одного запуска: идентификаторы, массивы, промежуточные результаты и тексты из элемента «Шаблон».
 
-1. Действие в процессе завершилось успешно.
-1. У действия настроены правила «Запись в хранилище процесса».
-1. Для каждого правила выполняется Go-шаблон из поля «Источник» с данными ответа действия; полученная строка записывается в хранилище под ключом, указанным в поле «Ключ в хранилище».
+Полное описание правил записи, операций, контекста цикла и примеров сценариев — в разделе [«Хранилище процесса»](store/).
 
-Если для одного и того же ключа пишут несколько действий (или одно и то же действие при повторном запуске), значение перезаписывается.
+Кратко:
 
-#### Поведение при отсутствующих данных
+- **Одно хранилище на запуск** — у каждого экземпляра процесса своё хранилище; его можно просмотреть на вкладке «Хранилище» при визуализации запуска.
+- **Вложенные пути** — ключи задаются через точку: `notification.module_name`, `ctx.job.id`; поддерживаются индексы массивов: `items[0].status`.
+- **Запись по правилам** — данные попадают в store после успешного выполнения действия (раздел [«Обновление хранилища процесса»](../../actions/overview/#обновление-хранилища-процесса)) или при проходе элемента «Шаблон». Доступны операции записи строки и JSON, добавления, слияния и удаления, а также условие на каждое правило.
+- **Чтение** — Go-шаблоны `{{ .store.<путь> }}` в конфигурации действий и условиях шлюзов (см. [«Хранилище процесса»](../../user/templating/#хранилище-процесса)).
 
-Если ключа нет в хранилище (действие ещё не выполнялось, не имело правил записи или запись не произошла), при выполнении шаблона `{{ .store.<ключ> }}` действие завершится с ошибкой.
+Если ключа нет в хранилище, шаблон `{{ .store.<путь> }}` завершит шаг с ошибкой.
 
 ## Запуск процесса
 
@@ -228,14 +244,15 @@ menuTitle: Процессы
 * Логи выполнения действий.
 * Статус каждого элемента процесса.
 * Хронологию выполнения процесса.
+* Содержимое [хранилища процесса](store/#просмотр-хранилища-при-выполнении) на вкладке «Хранилище».
 
 #### Таймлайн
 
 На панели визуализации запуска процесса доступна вкладка «Таймлайн», на которой отображается хронология выполнения процесса: для каждого элемента, который участвовал в текущем запуске, показаны время начала и окончания, длительность и статус.
 
 #### Лог процесса
 
-Для каждого запуска процесса доступен подробный лог его выполнения. Кнопка просмотра лога находится на экране визуализации выполнения процесса (иконка лога рядом с Fullscreen, Zoom, Refresh).
+Для каждого запуска процесса доступен подробный лог выполнения: панель на схеме запуска, отдельное окно или док внизу экрана. Лог и JSON хранилища можно скачать с панели диалога запуска процесса.
 
 ## Примеры использования