- Зачем:
- менти негде было понять с первого экрана, что перед ним и куда идти;
тикет #209 карты #206 открывает учебную документацию стенда.
- Что:
- создан docs/handbook/README.md: тропа чтения и пять аннотированных
будущих глав с временными ссылками на справочники.
- шапка README.md переписана для менти: четыре действия и ссылки на
путеводитель и уроки; в разделе «Документация» добавлены handbook и labs.
- в AGENTS.md добавлено правило имен для docs/handbook/.
- Проверка:
- команда проверки ссылок из тикета #209 — пустой вывод;
- git diff: операторские разделы README не тронуты.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
3.1 KiB
Путеводитель по стенду
Если вы впервые видите стенд, начните отсюда. Путеводитель подскажет, на что смотреть и в каком порядке, а за подробностями отправит в справочники. Так вы разберетесь в устройстве, прежде чем браться за уроки.
Как читать
Тропа такая: словарь понятий → главы путеводителя →
справочники docs/architecture/ →
уроки.
Словарь не надо читать подряд. Возвращайтесь к нему за незнакомым словом. Первая статья объясняет хранилище. Следом идет несколько статей об устройстве генератора; они понадобятся нескоро.
Будущие главы
Хранилище и его слои
От события в Kafka до витрины: глава разберет путь через STG, ODS, DDS и DM и покажет, за что отвечает каждый слой. Пока главы нет, смотрите справочник хранилища.
Потоки Airflow и пульт мира
Пульт играет модельный день, а дневной конвейер раскладывает данные по слоям. Глава поможет увидеть их связь и роль каждого дага. Пока главы нет, смотрите справочник конвейера и раздел «Пульт мира» корневого README.
Мониторинг: куда смотреть
Свежесть и поток данных, брак и отставание собраны на дашборде «Данные». Глава научит находить нужную панель и разбирать ее показания. Пока главы нет, смотрите устройство мониторинга.
Немного Superset
Глава покажет, как витрина становится графиком и где проходит граница между своими объектами и теми, которые поднимает стенд. Пока главы нет, смотрите справочник Superset.
Генератор: откуда берутся данные
Для менти генератор здесь — источник данных. Глава в общих чертах объяснит,
откуда берутся события и заказы и в каком виде их получает хранилище. Пока
главы нет, смотрите generator/ и
описание события кликстрима.