From a39dba6daeb9e91218b7447c9375a2736ed0901a Mon Sep 17 00:00:00 2001 From: Dmitry Dementev Date: Thu, 5 Feb 2026 22:12:51 +0300 Subject: [PATCH] docs: add runbook reference and makefile commands - Add reference to `plans/runbook.md` in key artifacts section - Add reference to `plans/kafka_ingest_plan.md` in key artifacts section - Document `make up`, `make ddl`, and `make data` commands in basic commands section --- AGENTS.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 3d7d3c7..d7a7107 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -15,6 +15,8 @@ ## Ключевые артефакты - `plans/clickhouse_ddl.md` — основной документ со схемой слоёв, DDL/MV и витринами DM. +- `plans/runbook.md` — runbook: порядок запуска (`make up`/`make ddl`/`make data`) и параметры. +- `plans/kafka_ingest_plan.md` — детальный план реализации загрузки данных в Kafka. - `data/DE-task.md` — текст задания. - `data/*.jsonl` — исходные данные (могут быть грязными). - `configs/` — конфиги ClickHouse/Prometheus/Grafana (по мере развития). @@ -29,6 +31,9 @@ Базовые команды: +- `make up` (или `docker compose up -d`) +- `make ddl` (применяет SQL из `plans/clickhouse_ddl.md` в ClickHouse) +- `make data` (пересоздаёт топики и заливает небольшой срез данных в Kafka; полный режим — `FULL=1 make data`) - `docker compose up -d` - `docker compose ps` - `docker compose logs -f --tail=200 `