sova-bootstrap
91 lines
2.6 KiB
Markdown
91 lines
2.6 KiB
Markdown
# Документация VitePress
|
|
|
|
Документация живёт в `docs` (монорепо) и зеркалируется в `k3s-test/sova-docs/` для test-контура.
|
|
|
|
## Test-контур (деплой)
|
|
|
|
Собранный сайт доступен на **http://docs.sova.local** (после `/etc/hosts`).
|
|
|
|
Сборка образа: multistage Dockerfile (`npm run build` → nginx). CI-тег: `docs-v*.*.*-test`.
|
|
|
|
## Запуск через Docker
|
|
|
|
### Из папки `docs` (отдельный compose)
|
|
|
|
```bash
|
|
cd docs
|
|
docker compose up -d
|
|
```
|
|
|
|
Остановка:
|
|
|
|
```bash
|
|
cd docs
|
|
docker compose down
|
|
```
|
|
|
|
Том `vitepress_node_modules` совпадает с файлом `environments/docker-compose.docs.yml` в корне репозитория (общий кеш `node_modules`).
|
|
|
|
URL: `http://localhost:5173`. Порт совпадает с запуском из корня — **не поднимайте оба варианта одновременно**.
|
|
|
|
### Из корня репозитория
|
|
|
|
```bash
|
|
make docs
|
|
```
|
|
|
|
Сайт будет доступен на `http://localhost:5173`.
|
|
|
|
Остановка:
|
|
|
|
```bash
|
|
make docs-down
|
|
```
|
|
|
|
Прямой Docker Compose-вызов из корня:
|
|
|
|
```bash
|
|
docker compose -f environments/docker-compose.docs.yml up -d
|
|
```
|
|
|
|
## Локальный запуск без Docker
|
|
|
|
```bash
|
|
cd docs
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
После запуска VitePress покажет локальный URL, обычно `http://localhost:5173`.
|
|
|
|
## Сборка
|
|
|
|
```bash
|
|
cd docs
|
|
npm run build
|
|
```
|
|
|
|
Результат сборки появится в `docs/.vitepress/dist`.
|
|
|
|
## Preview сборки
|
|
|
|
```bash
|
|
cd docs
|
|
npm run preview
|
|
```
|
|
|
|
## Как добавлять страницы
|
|
|
|
1. Создать `.md` файл внутри `docs`.
|
|
2. Добавить ссылку в `docs/.vitepress/config.mts` в `sidebar`.
|
|
3. Не переносить в документацию реальные секреты из `.env`.
|
|
4. Для команд указывать директорию запуска и контейнер, если команда выполняется через Docker.
|
|
|
|
## Что стоит дописать после получения всех исходников
|
|
|
|
- страницы по `frontend`, `adminPanel`, `sovamed`, `kiosk`;
|
|
- актуальную схему доменов и окружений;
|
|
- процесс деплоя через Jenkins;
|
|
- список внешних API и контактов владельцев интеграций;
|
|
- восстановление локальной БД из дампа.
|