From 8545734465fa2155ecab635e270aa38adcc1ba6e Mon Sep 17 00:00:00 2001 From: Spiridonov Max Date: Mon, 18 May 2026 15:03:50 +0300 Subject: [PATCH] first commit --- Components.md | 35 +++++++++++++++++++++++++++++++++++ Contributing.md | 25 +++++++++++++++++++++++++ FAQ.md | 33 +++++++++++++++++++++++++++++++++ Home.md | 30 ++++++++++++++++++++++++++++++ Overview.md | 36 ++++++++++++++++++++++++++++++++++++ Roadmap.md | 31 +++++++++++++++++++++++++++++++ Security.md | 31 +++++++++++++++++++++++++++++++ 7 files changed, 221 insertions(+) create mode 100644 Components.md create mode 100644 Contributing.md create mode 100644 FAQ.md create mode 100644 Home.md create mode 100644 Overview.md create mode 100644 Roadmap.md create mode 100644 Security.md diff --git a/Components.md b/Components.md new file mode 100644 index 0000000..8942612 --- /dev/null +++ b/Components.md @@ -0,0 +1,35 @@ +# Компоненты и репозитории + +Ниже — логическая карта экосистемы GitJet, с которой связан проект **gitjet.ru**. + +## Схема (упрощённо) + +- **Разработчики** и **эксплуатация** работают с **gitjet.ru** (веб и Git), при необходимости — с **registry.gitjet.ru** и **docs.gitjet.ru**. +- **gitjet.ru** — центральная точка для репозиториев, issues, wiki проектов и связанных сущностей. + +## Репозиторий gitjet/gitjet.ru + +**Назначение:** «точка входа» в продукт на уровне документации и метаданных: + +- описание статуса беты и roadmap в виде файлов в `docs/`; +- шаблоны Issues в `.github/`; +- **вики** (этот набор страниц) — живая документация по продукту. + +## registry.gitjet.ru + +- **Роль:** хранение и распространение контейнерных образов (OCI), используемых проектом и пользователями. +- **Для пользователей:** логин к registry настраивается политикой инстанса; точные команды см. в [docs.gitjet.ru](https://docs.gitjet.ru) при появлении соответствующих разделов. + +## docs.gitjet.ru + +- **Роль:** пользовательская и административная документация (установка, конфигурация, API — по мере наполнения). +- **Связь с вики:** вики репозитория **gitjet.ru** ближе к *продуктовому* описанию и дорожной карте; **docs** — к *эксплуатации и руководствам*. + +## Внешние связи + +- **Issues** централизованы в мета‑репозитории (см. [Contributing](Contributing)). +- **Сообщество** — канал в MAX (ссылка на [Home](Home)). + +## Версионирование + +Версия развёрнутого gitjet.ru отображается в интерфейсе (строка **Version** в подвале). Сопоставляйте её с тегами образов в registry при отладке. \ No newline at end of file diff --git a/Contributing.md b/Contributing.md new file mode 100644 index 0000000..459ade2 --- /dev/null +++ b/Contributing.md @@ -0,0 +1,25 @@ +# Участие в проекте + +## Обратная связь и баги + +- **Issues:** [gitjet/gitjet.ru/issues](https://gitjet.ru/gitjet/gitjet.ru/issues) +- Используйте шаблоны **Bug report** и **Feature request** в репозитории. + +Хороший отчёт об ошибке: + +- что ожидалось и что произошло; +- шаги воспроизведения; +- браузер / ОС (для UI); +- скриншот или фрагмент лога (без секретов). + +## Предложения по продукту + +Roadmap открыт для обсуждения: приоритеты учитывают голоса и реальные сценарии пользователей. Крупные идеи лучше оформлять отдельным issue с контекстом «зачем» и «кто пострадает, если не сделать». + +## Сообщество + +- Канал в **MAX** — ссылка в [Home](Home): новости, неформальные вопросы, быстрые уточнения. + +## Безопасность + +Уязвимости — только на **[security@gitjet.ru](mailto:security@gitjet.ru)**, не через публичные Issues. Подробности: [Security](Security). \ No newline at end of file diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..218f03c --- /dev/null +++ b/FAQ.md @@ -0,0 +1,33 @@ +# FAQ + +## Безопасно ли хранить важные репозитории на gitjet.ru? + +Сейчас действует **открытая бета**. Мы **не гарантируем** сохранность данных и бесперебойность на уровне продакшн‑SLA. Для критичных данных используйте резервное копирование и оценку рисков. + +## Где документация по установке своего инстанса? + +- Пользовательская и админская документация: [docs.gitjet.ru](https://docs.gitjet.ru) + +## Как связаться с командой по продукту? + +- **Issues:** [gitjet/gitjet.ru/issues](https://gitjet.ru/gitjet/gitjet.ru/issues) +- **Сообщество (MAX):** см. [Home](Home) +- **Безопасность:** [Security](Security) + +## Что такое registry.gitjet.ru? + +Публичный **Docker (OCI) registry** для образов экосистемы GitJet. Детали аутентификации и квот — в официальной документации по мере публикации. + +## Как предложить функцию из roadmap? + +Создайте issue с типом feature request или прокомментируйте существующий тикет. См. [Contributing](Contributing). + +## Вики репозитория и docs.gitjet.ru — в чём разница? + + +| | Вики gitjet.ru | docs.gitjet.ru | +| --------- | --------------------------------- | ------------------------------ | +| Фокус | Продукт, экосистема, roadmap, FAQ | Руководства, установка, API | +| Аудитория | Все пользователи и наблюдатели | Админы и активные пользователи | + + diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..d3269bf --- /dev/null +++ b/Home.md @@ -0,0 +1,30 @@ +# Документация проекта GitJet (gitjet.ru) + +Добро пожаловать в вики репозитория **[gitjet/gitjet.ru](https://gitjet.ru/gitjet/gitjet.ru)**. Здесь собрано описание продукта, экосистемы сервисов и того, как с нами работать. + +## Статус продукта + +**Открытая бета.** Сохранность данных и полная стабильность **не гарантируются**. Рекомендуется использовать в непродакшн-средах и с резервным копированием по вашей политике. + +## Быстрые ссылки + +| Ресурс | URL | +|--------|-----| +| Исходники мета-репозитория | [gitjet/gitjet.ru](https://gitjet.ru/gitjet/gitjet.ru) | +| Публичная документация | [docs.gitjet.ru](https://docs.gitjet.ru) | +| Docker Registry | [registry.gitjet.ru](https://registry.gitjet.ru) | +| Issues | [gitjet.ru/issues](https://gitjet.ru/gitjet/gitjet.ru/issues) | +| Сообщество (MAX) | [канал в MAX](https://max.ru/join/y8H0MJxeyJ7bC1tEomx-yBSIBpRFsw39DPxUlIfxw1s) | + +## Оглавление вики + +1. **[Обзор продукта](Overview)** — что такое GitJet и для кого он. +2. **[Компоненты и репозитории](Components)** — core-scm, registry, документация, связь между частями. +3. **[План развития (Roadmap)](Roadmap)** — что уже есть, что в работе, горизонт планов. +4. **[Безопасность](Security)** — как сообщать об уязвимостях, политика версий. +5. **[Участие в проекте](Contributing)** — issues, обсуждения, обратная связь. +6. **[FAQ](FAQ)** — частые вопросы. + +--- + +*Чтобы править эту вики через Git: клонируйте вики-репозиторий (в GitJet обычно доступен как `*.wiki.git` рядом с основным репо) и синхронизируйте файлы `.md` с такими же именами страниц.* diff --git a/Overview.md b/Overview.md new file mode 100644 index 0000000..8cd2da0 --- /dev/null +++ b/Overview.md @@ -0,0 +1,36 @@ +# Обзор продукта + +## Что такое GitJet + +**GitJet** — платформа для разработки и эксплуатации ПО с упором на **DevOps**, **хранение кода**, **CI/CD** (в планах и дорожной карте) и **AI‑агенты** (ревью, документация, анализ логов — по мере реализации). + +Публичный инстанс **gitjet.ru** даёт: + +- хостинг Git‑репозиториев и сопутствующий веб‑интерфейс; +- экосистему вокруг продукта: документация, registry, каналы связи с командой и сообществом. + +## Для кого + +- Командам, которым нужен **self-hosted‑подобный** опыт в облаке GitJet или **on‑prem** поставка (в планах). +- Разработчикам, готовым **тестировать бета‑функции** и влиять на приоритеты через issues и обратную связь. + +## Ключевые отличия и позиционирование + +- **Реактивный DevOps** — цель платформы: быстрые циклы от коммита до доставки, с автоматизацией и AI‑помощниками (по roadmap). +- **Открытая бета** — функции и сроки могут меняться; перед критичным использованием оцените риски (см. [Home](Home)). + +## Термины + + +| Термин | Значение | +| ---------------------- | --------------------------------------------------------------------------------------------------- | +| **gitjet.ru** | Публичный сайт и инстанс платформы; также мета‑репозиторий с документацией проекта. | +| **registry.gitjet.ru** | Публичный Docker/OCI registry для артефактов проекта. | + + +## Где читать дальше + +- [Компоненты и репозитории](Components) +- [План развития](Roadmap) +- [FAQ](FAQ) + diff --git a/Roadmap.md b/Roadmap.md new file mode 100644 index 0000000..f0ba045 --- /dev/null +++ b/Roadmap.md @@ -0,0 +1,31 @@ +# План развития (Roadmap) + +*Актуально на апрель 2026. При расхождении с файлом `docs/ROADMAP.md` в репозитории приоритет у версии в репозитории; эту страницу обновляйте вместе с ним.* + +## Реализовано (базовый каркас) + +- Первый запуск GitJet как основа платформы. +- Публичный Docker registry: **registry.gitjet.ru**. + +## В активной разработке + +- **Горячий репликатор метаданных** (WAL, автоматическое переключение с Patronix — уточняйте по актуальным релиз-ноутам и документации). + +## Следующие 3–6 месяцев (план) + +- **AI Code Reviewer** (on‑prem, CPU‑инференс). +- Интеграция с **GitFlic** / **GitVerse** через webhook. + +## Дальнейшие планы + +- **AI Docs Agent** — генерация и поддержка документации по изменениям в коде. +- **K8s Log Analysis Agent** — помощь в разборе логов Kubernetes. +- **Enterprise**‑версия с реестром ПО (уточняется бизнес‑моделью и roadmap). + +## Как влиять на приоритеты + +1. Голосуйте и комментируйте в **Issues** репозитория [gitjet/gitjet.ru](https://gitjet.ru/gitjet/gitjet.ru/issues). +2. Участвуйте в обсуждениях в сообществе (MAX) — ссылка в [Home](Home). + +> Сроки в бете **не фиксируются контрактом**. Приоритеты могут меняться в пользу стабильности и безопасности. + diff --git a/Security.md b/Security.md new file mode 100644 index 0000000..b42f482 --- /dev/null +++ b/Security.md @@ -0,0 +1,31 @@ +# Безопасность + +## Сообщение об уязвимости + +Если вы обнаружили уязвимость в продуктах или инфраструктуре GitJet: + +1. **Не создавайте публичный Issue** с описанием эксплуатации. +2. Напишите на **security@gitjet.ru**. + +Ожидаемый срок первого ответа: **до 3 рабочих дней** (цель, не SLA). + +В письме по возможности укажите: + +- затронутый компонент (gitjet.ru, registry, docs, и т.д.); +- шаги воспроизведения; +- оценку серьёзности (если есть); +- контакт для уточнений. + +## Политика версий (бета) + +- **Бета‑версии** не обязаны получать **backport** исправлений в старые ветки. +- Исправления безопасности и функциональность обычно идут в основную линию разработки (**main** / актуальные релизы — см. процесс в репозитории **core-scm**). + +## Ответственное раскрытие + +Мы благодарны исследователям, сообщающим проблемы конфиденциально. После исправления возможно публичное упоминание (по согласованию) в release notes или advisories. + +## См. также + +- [Участие в проекте](Contributing) — для обычных багов и идей (через Issues). +- Файл в репозитории: `docs/SECURITY.md`