docs: translate quickstart docs to russian#122
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #122 +/- ##
==========================================
- Coverage 71.52% 71.30% -0.23%
==========================================
Files 201 201
Lines 18167 18167
==========================================
- Hits 12994 12954 -40
- Misses 4453 4495 +42
+ Partials 720 718 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
📝 WalkthroughWalkthroughUpdated Quickstart docs: English quickstart reorganized (GHCR Docker single-node, explicit docker-compose, clarified modes/components, mapping.path: auto, cross-links); Russian quickstart fully localized and expanded with Docker/docker-compose examples, cluster guidance, config snippets, write/search samples, and seq-ui integration. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks (3 passed)✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (7)
docs/en/01-quickstart.md (4)
32-41: Fix registry reference: text says Docker Hub, command uses GHCR.Align wording with the actual image source.
Apply:
-Pull seq-db image from Docker Hub and create a container: +Pull the seq-db image from GitHub Container Registry (GHCR) and create a container:
71-91: Config path mismatch in docker-compose: mounted to /seq-db/config.yaml but command uses config.yaml.Use an absolute path (same for both services) and prefer a portable relative host path.
Apply:
- volumes: - - ${PWD}/config.yaml:/seq-db/config.yaml + volumes: + - ./config.yaml:/seq-db/config.yaml @@ - command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - volumes: - - ${PWD}/config.yaml:/seq-db/config.yaml + volumes: + - ./config.yaml:/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
107-118: Bulk example may fail: use newline-delimited JSON via --data-binary and end with a trailing newline.Also use
{}for the index action to avoid confusing “unused-key”.-curl --request POST \ - --url http://localhost:9002/_bulk \ - --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} -{"k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully"} -{"index" : {"unused-key":""}} -{"k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved"} -{"index" : {"unused-key":""}} -{"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} -' +curl --request POST \ + --url http://localhost:9002/_bulk \ + --header 'Content-Type: application/json' \ + --data-binary @- <<'JSON' +{ "index": {} } +{ "k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully" } +{ "index": {} } +{ "k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved" } +{ "index": {} } +{ "k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed" } +JSON
193-201: seq-ui config path mismatch: mounted to /seq-ui/config.yaml but command uses config.yaml.Use the absolute container path.
- command: --config config.yaml + command: --config /seq-ui/config.yamldocs/ru/01-quickstart.md (3)
75-92: Несоответствие путей конфигурации в docker-compose.Файл монтируется как /seq-db/config.yaml, а в командной строке указан config.yaml.
- volumes: - - ${PWD}/config.yaml:/seq-db/config.yaml + volumes: + - ./config.yaml:/seq-db/config.yaml @@ - command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - volumes: - - ${PWD}/config.yaml:/seq-db/config.yaml + volumes: + - ./config.yaml:/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
107-118: Пример bulk: нужен формат NDJSON и завершающая новая строка; лучше использовать --data-binary.Также используйте
{}вместо «unused-key».-curl --request POST \ - --url http://localhost:9002/_bulk \ - --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} -{"k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully"} -{"index" : {"unused-key":""}} -{"k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved"} -{"index" : {"unused-key":""}} -{"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} -' +curl --request POST \ + --url http://localhost:9002/_bulk \ + --header 'Content-Type: application/json' \ + --data-binary @- <<'JSON' +{ "index": {} } +{ "k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully" } +{ "index": {} } +{ "k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved" } +{ "index": {} } +{ "k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed" } +JSON
190-199: seq-ui: несоответствие пути к конфигу.Файл монтируется как /seq-ui/config.yaml, команда указывает config.yaml.
- volumes: - - ${PWD}/config.seq-ui.yaml:/seq-ui/config.yaml + volumes: + - ./config.seq-ui.yaml:/seq-ui/config.yaml @@ - command: --config config.yaml + command: --config /seq-ui/config.yaml
🧹 Nitpick comments (7)
docs/en/01-quickstart.md (4)
93-94: Provide an explicit compose command.Readers benefit from a copy-pasteable command.
-Alternatively, you can run `docker-compose.yaml` file from `quickstart` directory. +Alternatively, from the `quickstart` directory: +`docker compose up -f docker-compose.yaml -d`
127-142: Optional: pretty-print search results.If jq is installed (as noted), pipe to it.
- }' + }' | jq .
97-99: Add an explicit link to Architecture doc for parity with RU version.Helps discovery of modes and trade-offs.
-So we encourage you to read more about [mappings and how we index fields](03-index-types.md) and seq-db architecture and operating modes (single/cluster). +So we encourage you to read more about [mappings and how we index fields](03-index-types.md) and the [seq-db architecture](13-architecture.md) and operating modes (single/cluster).
43-46: Minor wording polish.Tighten phrasing.
-**Note:** The `--mode single` flag runs seq-db as a single binary, rather than in cluster mode. And the `mapping.path: auto` setting automatically indexes all fields as `keyword` type. +**Note:** The `--mode single` flag runs seq-db as a single binary (not in cluster mode). The `mapping.path: auto` setting automatically indexes all fields as `keyword`.docs/ru/01-quickstart.md (3)
52-54: Единообразие названий сервисов.Используйте официальные имена с дефисом.
-- seq-db proxy - принимает запросы и маршрутизирует их согласно конфигурации кластера -- seq-db store - отвечает за хранение и получение данных +- seq-db-proxy — принимает запросы и маршрутизирует их согласно конфигурации кластера +- seq-db-store — отвечает за хранение и получение данных
94-95: Добавьте явную команду запуска compose.Удобнее скопировать и выполнить.
-Также можно запустить файл `docker-compose.yaml` из директории `quickstart`, который содержит примерно такую же конфигурацию. +Также можно запустить из директории `quickstart`: +`docker compose up -f docker-compose.yaml -d`
221-229: Локализация ссылок и пунктуация.Сделайте подписи русскими и добавьте точки.
-- Собственный язык запросов - [seq-ql](05-seq-ql.md) - поддерживает конвейеры (pipes), запросы диапазонов, подстановочные символы (*) и другое. -- Поддержка построения различных агрегаций: сумма, среднее, квантили и так далее - [aggregations](13-aggregations.md) -- Возможность объединить в один запрос получение документов, агрегаций и гистограмм - [complex-search](10-public-api.md#complexsearch) -- Получение документов по ID - [fetch](10-public-api.md#fetch) +- Собственный язык запросов — [seq-ql](05-seq-ql.md): поддерживает конвейеры (pipes), диапазоны, подстановочные символы (*) и др. +- Поддержка агрегаций (сумма, среднее, квантили и т.д.) — [агрегации](13-aggregations.md). +- Возможность объединять документы, агрегации и гистограммы в одном запросе — [complex-search](10-public-api.md#complexsearch). +- Получение документов по ID — [fetch](10-public-api.md#fetch).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/01-quickstart.md(5 hunks)docs/ru/01-quickstart.md(10 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (3)
docs/ru/01-quickstart.md (3)
98-100: Небольшая правка формулировки и пунктуации.[ suggest_nitpick ]
-Обратите внимание, что мы установили настройку `mapping.path: auto`, это сделано для упрощения запуска, эта настройка не предназначена для использования в продакшене. -Поэтому мы рекомендуем прочитать больше о [маппингах и индексации полей](03-index-types.md) и [архитектуре](13-architecture.md) +Обратите внимание, что `mapping.path: auto` используется здесь для упрощения запуска и не предназначен для продакшена. +Рекомендуем прочитать больше о [маппингах и индексации полей](03-index-types.md) и [архитектуре](13-architecture.md).
141-146: Нит: улучшим формулировку.[ suggest_nitpick ]
-seq-ui это бэкенд для пользовательского интерфейса. +seq-ui — бэкенд для пользовательского интерфейса.
43-45: Нит: формулировка про keyword.[ suggest_nitpick ]
-И настройка `mapping.path: auto` позволяет автоматически индексировать все поля документа как `keyword` тип. +Настройка `mapping.path: auto` автоматически индексирует все поля документа как тип `keyword`.
forshev
force-pushed
the
0-translate-docs-quickstart
branch
from
2bafb60 to
c6cdc39
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/en/01-quickstart.md (2)
191-201: Fix seq-ui config path in compose.The volume mounts /seq-ui/config.yaml, but the command points to config.yaml. It will likely fail to locate the file.
Apply:
- command: --config config.yaml + command: --config /seq-ui/config.yaml
107-118: Use NDJSON content type and --data-binary for bulk.Bulk endpoints expect newline-delimited JSON and binary-safe transfer.
Apply:
- --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} + --header 'Content-Type: application/x-ndjson' \ + --data-binary '{"index" : {"unused-key":""}} {"k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully"} {"index" : {"unused-key":""}} {"k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved"} {"index" : {"unused-key":""}} {"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} 'docs/ru/01-quickstart.md (1)
108-118: NDJSON и --data-binary для bulk.Для корректной передачи newline-delimited JSON.
- --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} + --header 'Content-Type: application/x-ndjson' \ + --data-binary '{"index" : {"unused-key":""}} {"k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully"} {"index" : {"unused-key":""}} {"k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved"} {"index" : {"unused-key":""}} {"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} '
🧹 Nitpick comments (7)
docs/en/01-quickstart.md (2)
58-67: Persist store data in cluster quickstart.The store service has no persistent volume and the config lacks storage.data_dir in cluster mode. Add both so data survives restarts.
Config:
cluster: hot_stores: - seq-db-store:9004 mapping: path: auto +storage: + data_dir: /seq-db-dataCompose (store service):
seq-db-store: image: ghcr.io/ozontech/seq-db:latest volumes: - ${PWD}/config.yaml:/seq-db/config.yaml + - ${PWD}/data:/seq-db-data command: --mode store --config=config.yaml
75-91: Improve path portability in compose.${PWD} may not expand on Windows shells. Using a relative path is more portable.
Example:
- - ${PWD}/config.yaml:/seq-db/config.yaml + - ./config.yaml:/seq-db/config.yamldocs/ru/01-quickstart.md (5)
52-54: Уточните наименования компонентов.Используйте согласованные имена сервисов с дефисами.
-- seq-db proxy - принимает запросы и маршрутизирует их согласно конфигурации кластера -- seq-db store - отвечает за хранение и получение данных +- seq-db-proxy — принимает запросы и маршрутизирует их согласно конфигурации кластера +- seq-db-store — отвечает за хранение и получение данных
43-45: Лёгкая правка формулировки.Более естественные формулировки на русском.
-Обратите внимание, что флаг `--mode single` запускает seq-db в единственном исполняемом файле, а не в кластерном режиме. -И настройка `mapping.path: auto` позволяет автоматически индексировать все поля документа как `keyword` тип. +Обратите внимание: флаг `--mode single` запускает seq-db в виде единого бинаря (не кластер). +Настройка `mapping.path: auto` автоматически индексирует все поля документа как тип `keyword`.
76-91: Повысить переносимость путей в compose.${PWD} не гарантирован на Windows. Относительные пути проще.
- - ${PWD}/config.yaml:/seq-db/config.yaml + - ./config.yaml:/seq-db/config.yamlАналогично для всех сервисов.
Also applies to: 201-217
176-183: Добавьте персистентное хранилище для store.Как и в EN, стоит указать storage.data_dir и примонтировать каталог данных.
Config:
mapping: path: auto +storage: + data_dir: /seq-db-dataCompose (seq-db-store):
volumes: - ./config.yaml:/seq-db/config.yaml + - ./data:/seq-db-dataAlso applies to: 187-217
219-220: Дайте ссылку на документацию seq-ui.Добавьте явную ссылку (относительную, если доступна).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/01-quickstart.md(5 hunks)docs/ru/01-quickstart.md(10 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (2)
docs/en/01-quickstart.md (1)
93-94: Verify referenced docker-compose file exists.Confirm that quickstart/docker-compose.yaml is present in the repo and matches the examples.
docs/ru/01-quickstart.md (1)
94-95: Проверьте наличие файла quickstart/docker-compose.yaml.Убедитесь, что он существует и актуален.
forshev
force-pushed
the
0-translate-docs-quickstart
branch
2 times, most recently
from
29bedc2 to
6d8bf13
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/ru/01-quickstart.md (2)
83-91: Compose (cluster): same config path mismatch in proxy and store services.Файл смонтирован в /seq-db/config.yaml, а команда указывает config.yaml.
Исправьте обе команды:
- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml ... - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
202-217: Compose (seq-db-proxy/store with seq-ui): fix config paths here too.Та же проблема, что и выше.
Примените:
- command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml ... - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
♻️ Duplicate comments (1)
docs/ru/01-quickstart.md (1)
191-199: seq-ui compose: config path mismatch (repeat of earlier comment).Файл монтируется как /seq-ui/config.yaml, но команда указывает config.yaml.
Исправьте:
- command: --config config.yaml + command: --config /seq-ui/config.yaml
🧹 Nitpick comments (4)
docs/ru/01-quickstart.md (4)
108-119: Bulk example: use minimal{ "index": {} }meta to avoid confusion.Ключ unused-key избыточен и может сбивать с толку.
Предлагаю:
curl --request POST \ --url http://localhost:9002/_bulk \ --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} + --data '{"index": {}} {"k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully"} -{"index" : {"unused-key":""}} +{"index": {}} {"k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved"} -{"index" : {"unused-key":""}} +{"index": {}} {"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} '
35-41: Optional: persist data directory to avoid losing data on restart.В конфиге storage.data_dir: /seq-db-data, но том не смонтирован на хост.
Добавьте персистентный том:
docker run --rm \ -p 9002:9002 \ -p 9004:9004 \ -p 9200:9200 \ + -v "$(pwd)"/data:/seq-db-data \ -v "$(pwd)"/config.yaml:/seq-db/config.yaml \ -it ghcr.io/ozontech/seq-db:latest --mode single --config=/seq-db/config.yamlИ в compose для store:
seq-db-store: image: ghcr.io/ozontech/seq-db:latest volumes: - - ${PWD}/config.yaml:/seq-db/config.yaml + - ${PWD}/config.yaml:/seq-db/config.yaml + - ${PWD}/data:/seq-db-dataAlso applies to: 87-92, 213-218
80-83: Nit: 9200 on host often used by Elasticsearch — consider changing host port in examples.Чтобы избежать конфликтов на машинах с установленным ES, можно пробросить, например, 9299:9200.
Пример:
- - "9200:9200" # Default debug port + - "9299:9200" # Debug port (avoid clash with local Elasticsearch)Also applies to: 206-209
76-89: Optional: pin image tags instead of latest.latest может внезапно поломать пример. Рассмотрите фиксированные версии (или переменную IMAGE_TAG вверху страницы).
Пример:
- image: ghcr.io/ozontech/seq-db:latest + image: ghcr.io/ozontech/seq-db:v0.61.0Also applies to: 192-192, 202-202, 214-214
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/01-quickstart.md(5 hunks)docs/ru/01-quickstart.md(10 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/en/01-quickstart.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (1)
docs/ru/01-quickstart.md (1)
32-32: GHCR wording is correct.Упоминание реестра синхронизировано с фактическим образом. Ничего делать не нужно.
forshev
force-pushed
the
0-translate-docs-quickstart
branch
from
6d8bf13 to
caeaf20
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
docs/en/01-quickstart.md (4)
35-41: Fix broken --config path in docker run exampleThe file is mounted at /seq-db/config.yaml but the command points to config.yaml. This will fail to start.
Apply:
- -it ghcr.io/ozontech/seq-db:latest --mode single --config=config.yaml + -it ghcr.io/ozontech/seq-db:latest --mode single --config=/seq-db/config.yaml
77-91: Compose: use portable volume paths and correct absolute --config${PWD} is not guaranteed in all environments, and the --config path must match the in-container mount.
Apply:
- - ${PWD}/config.yaml:/seq-db/config.yaml + - ./config.yaml:/seq-db/config.yaml @@ - command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - - ${PWD}/config.yaml:/seq-db/config.yaml + - ./config.yaml:/seq-db/config.yaml - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yaml
194-203: Compose (seq-ui + seq-db): wrong config paths; fix mounts and flagsseq-ui points to config.yaml that isn’t mounted there; seq-db services also use relative --config.
Apply:
- - ${PWD}/config.seq-ui.yaml:/seq-ui/config.yaml + - ./config.seq-ui.yaml:/seq-ui/config.yaml @@ - command: --config config.yaml + command: --config /seq-ui/config.yaml @@ - - ${PWD}/config.yaml:/seq-db/config.yaml + - ./config.yaml:/seq-db/config.yaml @@ - command: --mode proxy --config=config.yaml + command: --mode proxy --config=/seq-db/config.yaml @@ - - ${PWD}/config.yaml:/seq-db/config.yaml + - ./config.yaml:/seq-db/config.yaml @@ - command: --mode store --config=config.yaml + command: --mode store --config=/seq-db/config.yamlAlso applies to: 206-221
109-118: Bulk example: use NDJSON content-type, --data-binary, and a proper index actionBulk endpoints expect application/x-ndjson with binary mode; the current header/flag may cause parsing issues.
Apply:
curl --request POST \ --url http://localhost:9002/_bulk \ - --header 'Content-Type: application/json' \ - --data '{"index" : {"unused-key":""}} + --header 'Content-Type: application/x-ndjson' \ + --data-binary '{"index":{}} {"k8s_pod": "app-backend-123", "k8s_namespace": "production", "k8s_container": "app-backend", "request": "POST", "request_uri": "/api/v1/orders", "message": "New order created successfully"} -{"index" : {"unused-key":""}} +{"index":{}} {"k8s_pod": "app-frontend-456", "k8s_namespace": "production", "k8s_container": "app-frontend", "request": "GET", "request_uri": "/api/v1/products", "message": "Product list retrieved"} -{"index" : {"unused-key":""}} +{"index":{}} {"k8s_pod": "payment-service-789", "k8s_namespace": "production", "k8s_container": "payment-service", "request": "POST", "request_uri": "/api/v1/payments", "message": "failed"} '
🧹 Nitpick comments (4)
docs/en/01-quickstart.md (4)
129-143: Either drop jq from the note or pipe to jqNote mentions jq but the command doesn’t use it.
Apply:
- }' + }' | jq
18-18: Capitalize DockerMinor wording polish.
Apply:
-seq-db can be quickly launched in a docker container. +seq-db can be quickly launched in a Docker container.
69-69: Standardize “Docker Compose” terminology and file namingUse “Docker Compose” (proper noun) and prefer ./compose.yaml or ./docker-compose.yaml consistently; also suggest referencing the exact path if the quickstart directory exists.
Proposed:
- “Here is a minimal Docker Compose example:”
- “Alternatively, run the ./docker-compose.yaml from the quickstart directory.”
Also applies to: 93-94
86-91: Persist data in Compose for the storeQuickstarts often benefit from persistence across restarts.
Apply:
seq-db-store: @@ - volumes: - - ./config.yaml:/seq-db/config.yaml + volumes: + - ./config.yaml:/seq-db/config.yaml + - ./data:/seq-db-dataAlso applies to: 216-221
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/en/01-quickstart.md(5 hunks)docs/ru/01-quickstart.md(10 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/ru/01-quickstart.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
4 participants
Description
translate quickstart docs to russian
If you have used LLM/AI assistance please provide model name and full prompt:
Summary by CodeRabbit