Введение
WARNING
Текст не отформатирован
Удобно тебе != удобно всем
Я работал в разных IT компаниях по разработке веб-сайтов/приложений и заметил отсутствие развития внутренней инфрастуктуры вне зависимости от возраста компании. Мне часто не хватало тех или иных вещей и речь не всегда про мою сферу фронтенда. В рамках данного проекта shalotts я скомпоную мнение пяти основных ролей: "devops/design/develop/tester/pm" - для создания удобной внутренней системы разработки. В крупных компаниях существуют и другие не менее важные роли, аналитик, тех. писатель и тд. Пока остановимся на основных которые присуще практически любой.
Данное руководство включает использование конфигуратора boilerplates (сборок) для быстрого развертывания. В документации и сборках будет упор на использование free/opensource продуктов.
В крупных компаниях, где есть система департаментов подобная дока является классикой, однако маленьким командам приходится выдумывать новые велосипеды и ездить на квадратных колёсах, заверяя всех - "Вот он! Велосипед моей мечты"
Философия проекта:
- Удобный канал коммуникации между ролями на разных стадиях
- Все имеют необходимый доступ для выполнения задач
- Каждая роль в силу наличие ресурсов/возможности обеспечивает себя и другие роли необходимыми данными и помогает автоматизировать
Все конфиги хранятся на GIT
WARNING
Материал рассчитан для начинающих компаний и стартапов (этап зарождения). Цель материала, построить удобные взаимоотношения между людьми в отделе веб-разработки не превышающий более 50 человек.
Создание страниц
Для создания страниц необходимо создать директорию внутри /docs с названием <Номер>_Name
Внутри папки размещаем файлы *.md, первым идёт index.md
Руководство по работе с markdown. На данный момент создаём папки первого уровня вложенности
В vitepress также включены дополнительные плагины для упрощения работы
---
parent: Название родителя (папки)
title: Название темы
---
# Название
Незабываем использовать семантику: абзацы, подчеркивание,
**жирность**, выделение `кода`
В случае большого участка кода используем конструкцию по оформлению кода
как в этом блоке (см. оригинальный файл docs/01_introduction/index.md)
## Делим по темам. Якорь создаётся автоматически справа
Удобно для навигации
Импорт кода из файла
<<< @/docs/public/assets/docker/s1/docker-compose.ymlContributors
shalotts