2.3 KiB
2.3 KiB
📘 Документация проекта
Этот репозиторий содержит технические руководства и инструкции, оформленные в виде Markdown-документов.
Здесь собраны практические мануалы по различным компонентам инфраструктуры, настройкам, процессам деплоя и внутренним инструментам.
Структура репозитория организована так, чтобы каждый мануал был изолирован и включал собственные изображения, примеры и сопутствующие материалы.
🗂 Структура репозитория
manuals/
<manual-name>/
README.md — основной файл мануала
images/ — изображения, схемы, скриншоты
Каждый мануал расположен в отдельном каталоге внутри docs/ и включает:
- подробные инструкции по теме
- примеры конфигураций
- схемы и иллюстрации
- последовательные шаги настройки или развёртывания
📑 Список доступных мануалов
- SSO — Регистрация в корпоративной SSO
🎯 Цели репозитория
- Централизованное хранение технической документации
- Унифицированный формат написания мануалов
- Удобная, масштабируемая структура
- Быстрый доступ к инструкциям в Git-репозитории
- Прозрачная история изменений каждого документа
🛠 Требования к оформлению мануалов
- Один мануал = один каталог
- Изображения хранятся только в подкаталоге
images/ - Ссылки на изображения задаются относительными путями:
