DocsBaseGM Knowledge Portal

Material for MkDocs + auth-gateway + Decap CMS

Единый портал знаний для всей компании

Портал собирает документацию из нескольких Git-репозиториев, публикует ее как современный сайт на Material for MkDocs, закрывает чтение через внешний auth-gateway и дает браузерное редактирование portal-owned контента через Decap CMS для технических редакторов. Imported docs остаются read-only mirror.

Ключевые разделы

Engineering

Архитектура, ADR, onboarding, сервисные страницы и инженерные гайды.

Infrastructure

Инфраструктура, окружения, доступы, платформенные решения.

Operations

Операционные процессы, процедуры, дежурства и регламенты.

Runbooks

Пошаговые сценарии реагирования на инциденты и типовые задачи.

Policies

Политики, правила, стандарты и внутренние соглашения.

Marketing

Позиционирование, контент, кампании, бренд-материалы.

Как это устроено

1. portal/sources/repos.yml описывает только ручные внешние репозитории.
2. portal/scripts/discover_github_docs_repos.py генерирует portal/sources/repos.generated.yml из GitHub org repos с docs/.
3. portal/scripts/build_portal_docs.py синхронизирует документы в portal/docs/imported/.
4. MkDocs строит портал с Material theme и поиском по всем страницам.
5. Читатели проходят в портал через внешний auth-gateway, например Authelia.
6. Decap CMS открывается в /admin/ и редактирует только portal-owned контент для технических редакторов с GitHub-аккаунтом.
7. Imported docs отображаются в портале как read-only mirror и редактируются в исходных репозиториях.
8. Кнопка редактирования для portal-owned страниц ведет в Decap, а для imported страниц - в исходный репозиторий, если ссылка известна.

Точка входа для редакторов

Для правки страниц откройте CMS. Доступ нужен только техническим редакторам:

Открыть CMS