Документация к etl-блоку¶
В составе etl-блока можно размещать файлы документации. Если документация у блока есть, то на форме ввода параметров появляется ссылка на неё.
При нажатии на эту ссылку, документация откроется в соседнем окне браузера.
Разметка¶
Документация к блоку пишется с использованием языка разметки Markdown и размещается в файле README.md.
Основные возможности Markdown по разметке текста указаны в официальной документации.
Также, можно использовать его расширенные возможности. Например, вставка таблиц.
id | parent_id | name | value
----|-----------|------------------|-----
1 | | Москва и область | Значение 1
2 | 1 | Москва | Значение 2
3 | 2 | Магазин 1 | Значение 3
4 | 2 | Магазин 2 | Значение 4
Изображения¶
Если в документации к блоку используются изображения, то их необходимо разместить в папке readme. Структура файлов блока в этом случае будет выглядеть так:
.
├── block_code.py
├── block_meta.json
├── block_test.py
├── readme
│ ├── image1.png
│ └── image2.png
└── README.md
Вставка самого изображения в текст документации выполяется стандартно для Markdown:
Пример документации¶
В разделе c примерами etl-блоков есть файл README.md с пользовательской документацией JSON-блока.