docs: translate the roadmap and frame it for an outside reader
test / test (push) Has been cancelled

roadmap.md is linked from the README table, so it is a page strangers land on.
Translated in full, with a note up front that none of it is a commitment:
there are no dates, the order is a recommendation, and an item can be dropped
once its plan is written. The note also points at product.md for the opposite
question — what the project deliberately will not do — so absence from the
roadmap is not read as a silent plan.

The model assigned to inbound-relay is dropped from the item; model routing
belongs in development.md, not in a statement of direction.

The README row described the file as internal and Russian. It is now neither.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
2026-08-09 22:46:58 +03:00
parent a4cfa11323
commit 06c2014384
3 changed files with 84 additions and 58 deletions
+5
View File
@@ -21,6 +21,11 @@ Format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/); version
unchanged: same requirements, same accepted risks, same ADR. The reviewing unchanged: same requirements, same accepted risks, same ADR. The reviewing
model is no longer named in the text; the fact that a pre-release review ran, model is no longer named in the text; the fact that a pre-release review ran,
and its date, stay. and its date, stay.
- [docs/roadmap.md](docs/roadmap.md) is now in English, with a short note on
how to read it from outside the project: nothing in it is a commitment, there
are no dates, and the stated order is a recommendation. The model assigned to
an item is no longer recorded there. The README row no longer calls the file
internal and Russian, because it is neither.
- The two remaining Russian source comments are in English: - The two remaining Russian source comments are in English:
`deploy/traefik/extract-cert.sh` (quote from spec 10.3) and `deploy/traefik/extract-cert.sh` (quote from spec 10.3) and
`internal/app/sasl.go`, where the quotation from the closed plan is dropped `internal/app/sasl.go`, where the quotation from the closed plan is dropped
+1 -1
View File
@@ -37,7 +37,7 @@ send log and DNS checks in the panel, encrypted backups.
| [Architecture](docs/architecture.md) | As-built technical design | | [Architecture](docs/architecture.md) | As-built technical design |
| [Security](docs/security.md) | Accepted security trade-offs and requirements | | [Security](docs/security.md) | Accepted security trade-offs and requirements |
| [Development](docs/development.md) | Building, testing, docs rules, model routing, commits | | [Development](docs/development.md) | Building, testing, docs rules, model routing, commits |
| [Roadmap](docs/roadmap.md) | Open work (1.x+) — internal, Russian | | [Roadmap](docs/roadmap.md) | Open work (1.x+) — direction, not commitments |
| [CHANGELOG](CHANGELOG.md) | Release history | | [CHANGELOG](CHANGELOG.md) | Release history |
Repository: <https://github.com/mixeme/selfpost> — source, issues, releases, and Repository: <https://github.com/mixeme/selfpost> — source, issues, releases, and
+78 -57
View File
@@ -1,100 +1,121 @@
# Дорожная карта: открытая работа (1.x+) # Roadmap: open work (1.x+)
**Статус:** внутренний трекер расширений границ v1.0 после явного согласования **Status:** a working tracker of extensions to the v1.0 boundary, each taken up
([product.md](product.md), [.cursor/rules/agent-rules.mdc](../.cursor/rules/agent-rules.mdc)). only after explicit agreement ([product.md](product.md),
Детальный дизайн — в [plans/](plans/). Пункты со статусом `кандидат` требуют OK [.cursor/rules/agent-rules.mdc](../.cursor/rules/agent-rules.mdc)). Detailed
до кодирования. design lives in [plans/](plans/). Items marked `candidate` need an OK before
any code is written.
**Версионирование:** по умолчанию SemVer MINOR в линии **1.x+** (`1.1.0`…), если **Reading this from outside the project:** nothing here is a commitment or a
дефолты и миграции совместимы с `1.0.0`. Major `2.x` — только при явном breaking. release promise. There are no dates, the order is a recommendation rather than
a schedule, and an item can be dropped or reshaped once its plan is written.
What the project *will not* do is a separate question, answered in
[product.md](product.md) — an item's absence from this file does not mean it is
planned but unlisted.
**Процесс:** [development.md](development.md). История закрытых фаз — в `git log` **Versioning:** SemVer MINOR in the **1.x+** line by default (`1.1.0`…), as long
и [CHANGELOG.md](../CHANGELOG.md). as defaults and migrations stay compatible with `1.0.0`. A major `2.x` only for
an explicit break.
**Process:** [development.md](development.md). The history of closed phases is
in `git log` and [CHANGELOG.md](../CHANGELOG.md).
--- ---
## Индекс ## Index
| ID | Тема | Статус | План | | ID | Topic | Status | Plan |
|---|---|---|---| |---|---|---|---|
| web-split | Разбиение `internal/web` | **согласовано** | [plans/web-split.md](plans/web-split.md) | | web-split | Splitting `internal/web` | **agreed** | [plans/web-split.md](plans/web-split.md) |
| domain-admin | Роль администратора домена | **согласовано** | [plans/domain-admin.md](plans/domain-admin.md) | | domain-admin | Domain administrator role | **agreed** | [plans/domain-admin.md](plans/domain-admin.md) |
| inbound-relay | Входящий релей (backup-MX / пересылка) | **согласовано** | [plans/inbound-relay.md](plans/inbound-relay.md) | | inbound-relay | Inbound relay (backup-MX / forwarding) | **agreed** | [plans/inbound-relay.md](plans/inbound-relay.md) |
| contributing | `CONTRIBUTING.md` | кандидат | — | | contributing | `CONTRIBUTING.md` | candidate | — |
**Рекомендуемый порядок** (не обязателен): **web-split → domain-admin → **Recommended order** (not binding): **web-split → domain-admin →
inbound-relay** — сначала разрез пакета, затем сквозная авторизация роли, затем inbound-relay** — first the package split, then role-wide authorisation, then
новый вертикальный срез входящего релея. Отклонение допустимо; жёстких фаз нет. the new vertical slice of the inbound relay. Deviating is allowed; there are no
hard phases here.
После `/clear` — пункт со статусом `согласовано` или `в работе`, затем чеклист в After a context reset, pick an item marked `agreed` or `in progress`, then work
linked plan. the checklist in its linked plan.
--- ---
## inbound-relay ## inbound-relay
**Цель:** опциональный приём почты на порт 25 для явно настроенных доменов и **Goal:** optional acceptance of mail on port 25 for explicitly configured
пересылка на upstream (backup-MX / relay-forwarder). По умолчанию выключено domains, forwarded to an upstream (backup-MX / relay-forwarder). Off by default
(`INBOUND_RELAY_ENABLE=false`); исходящий тракт без флага не меняется. (`INBOUND_RELAY_ENABLE=false`); without the flag the outbound path is
unchanged.
**Граница:** расширение v1.0 — [product.md](product.md) исключает приём входящей **Boundary:** an extension of v1.0 — [product.md](product.md) excludes inbound
почты и mailbox'ы. Это relay/forward, не IMAP/POP3/webmail; антиспам-движок — вне mail and mailboxes. This is relay/forward, not IMAP/POP3/webmail; an anti-spam
образа, только точка подключения. engine stays outside the image, only the attachment point is provided.
**Готово, когда:** см. критерии в [plans/inbound-relay.md](plans/inbound-relay.md). **Done when:** see the criteria in
[plans/inbound-relay.md](plans/inbound-relay.md).
**Зависимости / риски:** готовый исходящий тракт; open relay/backscatter; **Dependencies / risks:** a finished outbound path; open relay and backscatter;
расширение поверхности атаки (порт 25 на приём). Модель: Opus. a wider attack surface (port 25 accepting mail).
**Порядок:** рекомендуется после [web-split](plans/web-split.md) и **Order:** recommended after [web-split](plans/web-split.md) and
[domain-admin](plans/domain-admin.md). [domain-admin](plans/domain-admin.md).
**Версия:** целевой bump `1.x`; возможен `2.x` — уточнить по итогам реализации. **Version:** target bump `1.x`; `2.x` possible — to be settled once the
implementation lands.
--- ---
## domain-admin ## domain-admin
**Цель:** роль с доступом к одному или нескольким назначенным доменам **Goal:** a role with access to one or several assigned domains (the list is
(перечень задаёт глобальный администратор) — приложения, DKIM/DNS, журнал set by the global administrator) — applications, DKIM/DNS, and the send log for
отправки по каждому из них; без глобальных операций (добавление доменов, полный each of them; without global operations (adding domains, full backup, the
бэкап, очередь, `mail.log`). queue, `mail.log`).
**Граница:** расширение v1.0 — [product.md](product.md) фиксирует одного **Boundary:** an extension of v1.0 — [product.md](product.md) fixes a single
администратора. Не вторая копия всевластного админа, а ограниченный доступ к administrator. Not a second all-powerful admin, but limited access to the
назначенным доменам (одному или нескольким). assigned domains (one or several).
**Готово, когда:** см. [plans/domain-admin.md](plans/domain-admin.md). **Done when:** see [plans/domain-admin.md](plans/domain-admin.md).
**Зависимости / риски:** таблица пользователей, роль в сессии, авторизация в **Dependencies / risks:** a users table, the role in the session, authorisation
каждом хендлере, setup/бэкап. **Порядок:** рекомендуется после in every handler, setup and backup. **Order:** recommended after
[web-split](plans/web-split.md), до [inbound-relay](plans/inbound-relay.md). [web-split](plans/web-split.md), before
**Версия:** `1.x` MINOR при совместимой миграции текущего админа в глобального. [inbound-relay](plans/inbound-relay.md).
**Version:** `1.x` MINOR, given a compatible migration of the current
administrator into a global one.
--- ---
## web-split ## web-split
**Цель:** осознанно разрезать `internal/web` (или зафиксировать плоский пакет) **Goal:** deliberately split `internal/web` (or settle on keeping the package
перед ростом от inbound-relay и domain-admin. flat) before it grows under inbound-relay and domain-admin.
**Граница:** внутренний рефакторинг; поведение панели для оператора не меняется. **Boundary:** an internal refactor; the panel's behaviour for the operator does
not change.
**Готово, когда:** пакет разрезан по выбранной схеме или зафиксировано, что **Done when:** the package is split along the chosen scheme, or it is settled
остаётся плоским — см. [plans/web-split.md](plans/web-split.md). that it stays flat — see [plans/web-split.md](plans/web-split.md).
**Зависимости / риски:** экспорт пакетно-приватного API. **Порядок:** рекомендуется **Dependencies / risks:** exporting a package-private API. **Order:**
**первым** среди согласованных фич (до domain-admin и inbound-relay). recommended **first** among the agreed features (before domain-admin and
**Версия:** `1.x`, сам по себе breaking не тянет. inbound-relay).
**Version:** `1.x`; on its own it does not force a break.
--- ---
## contributing ## contributing
**Цель:** `CONTRIBUTING.md` в корне — dev loop, проверки перед PR, протокол **Goal:** `CONTRIBUTING.md` in the root — the dev loop, the checks to run
коммитов; [development.md](development.md) ссылается, не дублирует. before a PR, the commit protocol; [development.md](development.md) links to it
rather than repeating it.
**Граница:** документация процесса; уместна при внешнем потоке PR. **Boundary:** process documentation; worth writing once there is an external
flow of PRs.
**Готово, когда:** файл в корне; development.md не дублирует его. **Done when:** the file is in the root and development.md does not duplicate
it.
**Зависимости / риски:** пока один разработчик и нет PR — низкий приоритет. **Dependencies / risks:** with a single developer and no PRs, this is low
**Версия:** без значения для semver. priority.
**Version:** no bearing on semver.