docs(accuracy): профильная документация выверена по коду
- Зачем:
- профильные доки отстали от реализации: схема ods.*_errors, DQ-split и
сборка dds.event описывались неверно, ряд артефактов и параметров отсутствовал.
Канон по этим темам де-факто задают свежие уроки 2–3 курса.
- Что:
- ARCHITECTURE: ods.*_errors как копия с Kafka-метаданными+raw+error_reason;
DQ-split подан как пересекающийся; dds.event — browser-driven LEFT JOIN с
маркером location_not_found; добавлен перечень DQ-маркеров; уточнены
dq_summary (слой dm, orphan_events) и v_session_overview.
- REPO_MAP: добавлен sql/ods/20_stg_to_ods.sql, утилиты DAG, скрипты Superset;
scripts/make помечены как запасной путь, Airflow — основной.
- OPERATIONS: параметр wait_stg_timeout_sec; порт Superset и креды ClickHouse.
- SUPERSET_DASHBOARD: исправлен пароль ClickHouse (123456); убран сломанный
make superset-export, удалён superset/export_dashboard.py и target в Makefile.
- Проверка:
- git diff проверен против sql/*, airflow/dags/*, configs/default_user.xml;
ER-диаграмма провалидирована mermaid-валидатором.
This commit is contained in:
@@ -1,6 +1,15 @@
|
||||
# Аудит точности технической документации против кода
|
||||
|
||||
Дата: 2026-06-06 · Статус: открыто (починка не начата)
|
||||
Дата: 2026-06-06 · Статус: **закрыто** (все 12 находок починены 2026-06-06)
|
||||
|
||||
> Резолюция. 🔴 #1–#3 правлены в `ARCHITECTURE.md` (схема `*_errors`, DQ-split как
|
||||
> пересекающийся, `dds.event` как browser-driven LEFT JOIN + маркер `location_not_found`) —
|
||||
> формулировки подтянуты к урокам 2–3. #4: владелец решил **убрать** `make superset-export`
|
||||
> (раздел доки + target в Makefile + битый `superset/export_dashboard.py` удалены).
|
||||
> 🟡 #6–#10 и 🟢 #11–#12 закрыты в `ARCHITECTURE.md`/`OPERATIONS.md`/`REPO_MAP.md`
|
||||
> (добавлен перечень DQ-маркеров, параметр `wait_stg_timeout_sec`, порты Superset/креды CH,
|
||||
> пропущенные артефакты). Заодно зафиксирована рамка: основной путь — Airflow,
|
||||
> `scripts/`/`make` — запасной.
|
||||
|
||||
Контекст: при переработке корневого `README.md` (mentee-first) встал вопрос, можно ли
|
||||
смело отправлять читателя в профильные доки — не устарели ли они сами. Прогнали сверку
|
||||
|
||||
Reference in New Issue
Block a user