Процесс добавления/обновления документации

1. Склонировать репозиторий https://gitlab.maximumtest.ru/umax/b2b-products/schema
   
   
2. Описать документацию в формате Markdown (можно описать просто текстом и отформатировать онлайн, например, здесь - https://stackedit.io/app#)
   
   
3. Файл документации должен иметь название формата "service_system_name.mdx" (список возможных service_system_name смотри ниже) или "service_relation_system_name.mdx" (список возможных service_relation_system_name смотри ниже) соответственно тому, документация это сервиса или связей между сервисами
   
   
4. Файл документации необходимо расположить в соответствующей папке проекта
   
   Для сервиса это будет одна из следующих папок:

   • /src/app/services/[service]/docs (для общей информации)
   • /src/app/services/[service]/docs/tech (для технической документации)
   • /src/app/services/[service]/docs/business (для бизнесовой документации)

   
   Для связи между сервисами это будет одна из следующих папок:

   • /src/app/service-relations/[service-relation]/docs (для общей информации)
   • /src/app/service-relations/[service-relation]/docs/tech (для технической документации)
   • /src/app/service-relations/[service-relation]/docs/business (для бизнесовой документации)

   
   

   Скриншот расположения файлов документации на примере сервиса web
   
   
5. После добавления/изменения файлов документации необходимо залить изменения в репозиторий, выполнив следующие команды (для этого нужно иметь соответствующие права):

   • git add .
   • git commit -m "update docs: *здесь указать названия файлов, которые были добавлены/изменены*"
   • git push
   
   
6. Подождать, пока пройдет пайплайн и изменения будут применены
   
   

• web: web
• billing: billing
• 1с: one-s
• crm: crm
• АЦ: iam
• м.класс: m-class
• ЛК родителя: lk
• ЛК ученика/преподавателя (LMS): lms
• dadata: dadata
• VK: vk
• Т-Банк: t-bank
• Альфа Банк: alpha-bank
• Яндекс Банк: yandex-bank
• Kvell: kvell
• Раппорто: rapporto
• Mindbox: mindbox

• web --- billing: web-to-billing
• web --- crm: web-to-crm
• web --- АЦ: web-to-iam
• web --- ЛК родителя: web-to-lk
• web --- ЛК ученика/преподавателя (LMS): web-to-lms
• billing --- 1с: billing-to-one-s
• billing --- crm: billing-to-crm
• crm --- 1с: crm-to-one-s
• crm --- АЦ: crm-to-iam
• crm --- ЛК родителя: crm-to-lk
• crm --- ЛК ученика/преподавателя (LMS): crm-to-lms
• м.класс --- АЦ: m-class-to-iam
• м.класс --- ЛК ученика/преподавателя (LMS): m-class-to-lms
• ЛК родителя --- АЦ: lk-to-iam
• ЛК родителя --- ЛК ученика/преподавателя (LMS): lk-to-lms
• web --- dadata: web-to-dadata
• м.класс --- VK: m-class-to-vk
• billing --- Т-Банк: billing-to-t-bank
• billing --- Альфа Банк: billing-to-alpha-bank
• billing --- Яндекс Банк: billing-to-yandex-bank
• billing --- Kvell: billing-to-kvell
• АЦ --- Раппорто: iam-to-rapporto
• АЦ --- Mindbox: iam-to-mindbox
• ЛК ученика/преподавателя (LMS) --- Mindbox: lms-to-mindbox
• crm --- Mindbox: crm-to-mindbox
• web --- Mindbox: web-to-mindbox