Merge pull request 'docs(handbook): скелет путеводителя и README-шапка' (#210) from 209-handbook-skeleton into main

Reviewed-on: #210
This commit was merged in pull request #210.
This commit is contained in:
ddmitry committed 2026-09-01 21:30:25 +03:00
commit 2588515b9a
3 files changed
+64 -1

No files matched your search

+4
View File
@@ -161,6 +161,10 @@ Airflow) и названия из кода. Если для понятия ес
(`top-pages-daily.md`), индекс папки — `README.md`. Здесь живут ТЗ учебных
заданий. Ни даты, ни номера: задание — не событие истории, а живой документ,
и правится он вместе с тем, о чем говорит. Слаг называет предмет задания.
- Имена файлов в `docs/handbook/` — слаг строчными латинскими буквами через
дефис, индекс папки — `README.md`. Здесь живет путеводитель по стенду:
учебные главы для менти. Ни дат, ни номеров: глава — живой документ и
правится вместе с тем, что описывает.
- Имена файлов в `docs/adr/` — `NNNN-краткое-имя.md`: сквозной номер из четырёх
цифр и слаг (`0001-stand-services.md`). Решения нумеруются подряд, дата
в имени не нужна.
+11 -1
View File
@@ -1,8 +1,15 @@
# Учебная дата-платформа кликстрима
Стенд для работы с кликстримом. Преемник учебного стенда
Этот стенд — для менти, который видит такую систему впервые и хочет
проследить весь путь данных: от кликстрима и заказов до витрин, проверок и
графиков. Преемник учебного стенда
[clickstream-ch-kafka-superset-demo](https://git.dementev.space/ddmitry/clickstream-ch-kafka-superset-demo).
Поднять стенд поможет [«Быстрый старт»](#быстрый-старт), выключить —
`make down`. Чтобы разобраться в устройстве, начните с
[путеводителя](docs/handbook/README.md), а учиться — с
[уроков](docs/labs/README.md).
## Статус
Репозиторий строится по спеке
@@ -410,6 +417,9 @@ Superset закреплён на 6.1.0; драйвер `clickhouse-connect`, ф
## Документация
- [docs/handbook/](docs/handbook/) — путеводитель по стенду и порядок чтения.
- [docs/labs/](docs/labs/) — учебные задания с порядком прохождения и
самопроверкой.
- [docs/specs/](docs/specs/) — спеки: источник истины о задуманном.
- [docs/adr/](docs/adr/) — принятые решения с доводами и отвергнутыми
вариантами: почему сделано так, а не иначе.
+49
View File
@@ -0,0 +1,49 @@
# Путеводитель по стенду
Если вы впервые видите стенд, начните отсюда. Путеводитель подскажет, на что
смотреть и в каком порядке, а за подробностями отправит в справочники. Так вы
разберетесь в устройстве, прежде чем браться за уроки.
## Как читать
Тропа такая: [словарь понятий](../../CONTEXT.md) → главы путеводителя →
[справочники `docs/architecture/`](../architecture/) →
[уроки](../labs/README.md).
Словарь не надо читать подряд. Возвращайтесь к нему за незнакомым словом.
Первая статья объясняет хранилище. Следом идет несколько статей об устройстве
генератора; они понадобятся нескоро.
## Будущие главы
### Хранилище и его слои
От события в Kafka до витрины: глава разберет путь через STG, ODS, DDS и DM
и покажет, за что отвечает каждый слой. Пока главы нет, смотрите
[справочник хранилища](../architecture/storage.md).
### Потоки Airflow и пульт мира
Пульт играет модельный день, а дневной конвейер раскладывает данные по слоям.
Глава поможет увидеть их связь и роль каждого дага. Пока главы нет, смотрите
[справочник конвейера](../architecture/etl.md) и
[раздел «Пульт мира» корневого README](../../README.md#пульт-мира).
### Мониторинг: куда смотреть
Свежесть и поток данных, брак и отставание собраны на дашборде «Данные».
Глава научит находить нужную панель и разбирать ее показания. Пока главы
нет, смотрите [устройство мониторинга](../architecture/monitoring/README.md).
### Немного Superset
Глава покажет, как витрина становится графиком и где проходит граница между
своими объектами и теми, которые поднимает стенд. Пока главы нет, смотрите
[справочник Superset](../architecture/superset.md).
### Генератор: откуда берутся данные
Для менти генератор здесь — источник данных. Глава в общих чертах объяснит,
откуда берутся события и заказы и в каком виде их получает хранилище. Пока
главы нет, смотрите [`generator/`](../../generator/) и
[описание события кликстрима](../formats/clickstream-event.md).