docs(readme): корневой README пересобран по четырем блокам
Зачем: README был складом сведений, осевших там, где писались. По раскладке резолюции #211 он становится лицом репозитория: промо-блок, «куда я попал», типовые действия, ссылки. Слово «менти» уходит из README и путеводителя, хвосты #212 и #214 закрываются. Что: промо-цитата со ссылкой на план обучения и ментора; шапка с нейтральной адресацией и одной фразой о составе и пути данных; «Быстрый старт» сжат до двух команд по решению владельца — проверки остаются роботам, в README одна ссылка на карту проверок; разделы «Адреса и пароли», «Сдвинуть мир вперед», «Вернуть мир к началу», «Выключить или сбросить целиком», «Подключиться из DBeaver»; «Документация» называет все семь справочников вложенным списком. Умерли «Статус», «Что здесь будет», «Чем отличается от предшественника» и три заголовка-якоря. В world.md снята устаревшая фраза о «даге этапа 5», stand.md и ADR 0007 ведут на новый раздел «Адреса и пароли», в путеводителе снято слово «менти». Проверка: скрипт ссылок пуст, grep «менти» по README и путеводителю пуст, make config-test зеленый. Саморевью Sol 1/1; слепое ревью Opus — 0 блокеров, 2 minor, 3 nit, все закрыты; вычитка прозы ai-text-lint и оптикой литературного русского — 15 находок, 9 внесены, 6 отклонены как слова владельца и термины. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
This commit is contained in:
1 parent
e56b23816e
commit
7108cd4af3
5 files changed
+72
-91
No files matched your search
@@ -43,7 +43,7 @@
|
||||
Сетевых ограничений на `default` нет: порты стенда и так открыты только на
|
||||
`127.0.0.1`, а внутри сети Compose дверь заперта паролем.
|
||||
|
||||
Раздел README «Состав и доступ» описывает, кто каким пользователем ходит и где
|
||||
Раздел README «Адреса и пароли» описывает, кто каким пользователем ходит и где
|
||||
живут пароли; здесь остаются решение и доводы. Отдельного справочника по
|
||||
доступу в `docs/architecture/` нет: точные права видны в `access.xml`, конвенция
|
||||
чтения через `_v` описана в доке хранилища.
|
||||
@@ -107,7 +107,7 @@
|
||||
источник истины — файл в git. Стенд считает `access.xml` и переданные через
|
||||
`.env` значения настройкой при создании контейнера; отдельного способа
|
||||
применять их на живом стенде нет, потому что уроки не меняют базовую модель
|
||||
доступа. Порядок применения изменений — в разделе README «Состав и доступ».
|
||||
доступа. Порядок применения изменений — в разделе README «Адреса и пароли».
|
||||
Оба варианта с SQL — локальное хранилище доступа с `ON CLUSTER` и
|
||||
реплицированное в keeper — делают пользователей состоянием тома: `.env` на
|
||||
них больше не влияет, и появляется расхождение того же сорта, которое README
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
настройки доходят до контейнеров. Состав каркаса обоснован в
|
||||
[ADR 0001](../adr/0001-stand-services.md), доступ к ClickHouse — в
|
||||
[ADR 0007](../adr/0007-clickhouse-access.md). Адреса и пароли интерфейсов
|
||||
остаются в [корневом README](../../README.md#состав-и-доступ).
|
||||
остаются в [корневом README](../../README.md#адреса-и-пароли).
|
||||
|
||||
## Службы
|
||||
|
||||
|
||||
@@ -111,8 +111,8 @@ uv run --project generator python -m clickstream_generator batch \
|
||||
```
|
||||
|
||||
За один запуск можно проиграть несколько дней подряд: `--days 8`. Всё, что
|
||||
принимается флагами, принимается и переменными окружения — так генератор позовёт
|
||||
даг этапа 5; полный список у `--help`.
|
||||
принимается флагами, принимается и переменными окружения — так генератор
|
||||
запускают даги модельного времени; полный список у `--help`.
|
||||
|
||||
**Значения по умолчанию есть не у всех параметров, и это сделано специально.**
|
||||
Зерно, число дней и темп живого дня описывают модель мира — их генератор знает
|
||||
|
||||
@@ -43,7 +43,7 @@
|
||||
|
||||
### Генератор: откуда берутся данные
|
||||
|
||||
Для менти генератор здесь — источник данных. Глава в общих чертах объяснит,
|
||||
откуда берутся события и заказы и в каком виде их получает хранилище. Пока
|
||||
главы нет, смотрите [`generator/`](../../generator/) и
|
||||
Здесь генератор — источник данных, а не предмет изучения. Глава в общих
|
||||
чертах объяснит, откуда берутся события и заказы и в каком виде их получает
|
||||
хранилище. Пока главы нет, смотрите [`generator/`](../../generator/) и
|
||||
[описание события кликстрима](../formats/clickstream-event.md).
|
||||
Reference in new issue
Block a user