feat(topbar): «Что нового» button + 2026-05-12 state.md update
This commit is contained in:
+49
-7
@@ -1,16 +1,48 @@
|
||||
# Ordinis НСИ ЦУОД ОДХ — Integrator Guide
|
||||
# Ordinis НСИ ЦУОД ОДХ
|
||||
|
||||
Документация для команд, интегрирующих свои сервисы с Ordinis НСИ ЦУОД.
|
||||
Сюда не входят operator runbooks и архитектурные deep-dives — те материалы
|
||||
во внутренней документации проекта.
|
||||
Документация продукта Ordinis. Здесь — материалы для трёх ролей:
|
||||
|
||||
**Anchor v1 — production LIVE на cluster.142** (с 2026-05-07).
|
||||
- **Операторы справочников** — заводят и поддерживают данные
|
||||
- **Ревьюеры schema drafts** — принимают решения об изменениях схем
|
||||
- **Разработчики-интеграторы** — подключают свои сервисы к API
|
||||
|
||||
Архитектурные deep-dive'ы, runbook'и для ops-команды и project state —
|
||||
во внутренней документации проекта (не публикуется).
|
||||
|
||||
**Anchor v1 — production LIVE на cluster.264** (с 2026-05-07).
|
||||
Альтум consumers подключены, blue/green cutover завершён.
|
||||
|
||||
## С чего начать
|
||||
|
||||
{% list tabs %}
|
||||
|
||||
- Я оператор справочников
|
||||
|
||||
Заводишь записи (спутники, наземные станции, типы антенн)? Начни с
|
||||
[руководства оператора](operator/index.md).
|
||||
|
||||
Самое полезное:
|
||||
- [Создание справочника](operator/create-dictionary.md) — если справочника
|
||||
ещё нет, нужно создать новый
|
||||
- [Работа с записями](operator/edit-record.md) — добавить, изменить,
|
||||
найти запись
|
||||
- [Закрытие записи](operator/close-record.md) — корректно «удалить»,
|
||||
сохранив историю
|
||||
- [Разбор ошибок](operator/errors.md) — что значит сообщение, которое
|
||||
вылетело
|
||||
|
||||
- Я ревьюер schema drafts
|
||||
|
||||
Принимаешь решения об изменении схем справочников? Смотри
|
||||
[руководство ревьюера](reviewer/index.md) и
|
||||
[пошаговую инструкцию ревью](reviewer/schema-drafts.md).
|
||||
|
||||
Главное помнить:
|
||||
- Не ломать существующие записи (breaking changes — через миграцию)
|
||||
- Не ломать downstream (Альтум, BI) — согласуй, если меняешь поле,
|
||||
которое они читают
|
||||
- Документируй причину approve/reject в комментарии (это аудит)
|
||||
|
||||
- Я интегрирую свой сервис
|
||||
|
||||
Начни с [обзора API](integration/api/index.md) и [авторизации](integration/api/auth.md).
|
||||
@@ -28,7 +60,7 @@
|
||||
- [Bundle cuod](integration/api/bundle-cuod.md) — список 40 справочников ЦУОД
|
||||
- [Best practices](integration/api/best-practices.md) — частые ошибки
|
||||
|
||||
- Я обрабатываю ошибки
|
||||
- Я обрабатываю ошибки в интеграции
|
||||
|
||||
- [Ошибки и rate limits](integration/api/errors.md) — error codes, retry strategy
|
||||
- [Лучшие практики](integration/api/best-practices.md) — robust integration
|
||||
@@ -37,11 +69,19 @@
|
||||
|
||||
Открой [Swagger UI](https://ordinis.k8s.264.nstart.cloud/swagger-ui.html) —
|
||||
там можно нажать **Authorize** → войти через Keycloak (PKCE, без secret) →
|
||||
и сразу делать "Try it out" с реальным JWT. Authorization, error codes,
|
||||
и сразу делать «Try it out» с реальным JWT. Authorization, error codes,
|
||||
schemas — всё через interactive UI.
|
||||
|
||||
{% endlist %}
|
||||
|
||||
## Что нового в продукте
|
||||
|
||||
Список значимых обновлений — в [«Что нового»](changelog.md). Обновления
|
||||
автоматически приходят на твой сервер при следующем deploy.
|
||||
|
||||
Кнопка «Что нового» в правом верхнем углу админ-панели показывает то же
|
||||
содержимое + красная точка с количеством непрочитанных релизов.
|
||||
|
||||
## Среды
|
||||
|
||||
| Среда | URL | Auth | Назначение |
|
||||
@@ -54,6 +94,8 @@
|
||||
|
||||
- Запросы новых ролей / scope в Keycloak: `zimin.an@nstart.space`
|
||||
- Bug reports / feature requests: через issue tracker (запросить URL у Ordinis team)
|
||||
- Проблема с конкретной записью или ошибкой? Сначала загляни в
|
||||
[Разбор ошибок](operator/errors.md) — часто там сразу ответ
|
||||
|
||||
## Версионирование
|
||||
|
||||
|
||||
Reference in New Issue
Block a user