Skip to content

Commit f062b22

Browse files
committed
Corrected paths in documentation
1 parent 97c9f43 commit f062b22

4 files changed

Lines changed: 25 additions & 13 deletions

File tree

docs/en/01_overview.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
# 📘 ОПИСАНИЕ ПРОЕКТА
1+
# 📘 PROJECT DESCRIPTION
22

3-
Этот проект демонстрирует реализацию профессионального **CI/CD** пайплайна с использованием **Docker** и **GitHub Actions**.
3+
This project demonstrates the implementation of a professional **CI/CD** pipeline using **Docker** and **GitHub Actions**.
44

55
---
66

7-
## 🔍 Основные компоненты проекта
7+
## 🔍 Main project components
88

9-
Проект включает три контейнеризированных модуля:
9+
The project includes three containerized modules:
1010

11-
- **Backend**: Flask-приложение (Python API)
12-
- **Frontend**: веб-интерфейс на Node.js (Express)
13-
- **Reverse Proxy**: сервер на базе Nginx
11+
- **Backend**: Flask application (Python API)
12+
- **Frontend**: Node.js web interface (Express)
13+
- **Reverse Proxy**: Nginx-based server
1414

1515
---
1616

17-
## 🎯 Цель проекта
17+
## 🎯 Project goal
1818

19-
Цель — продемонстрировать настройку **автоматической сборки**, **тестирования** и **публикации Docker-образов** в Docker Hub, а также локальный запуск сервисов через Docker Compose.
19+
The goal is to demonstrate the setup of **automatic build**, **testing** and **publishing Docker images** to Docker Hub, as well as local launch of services via Docker Compose.
2020

21-
Проект будет полезен:
21+
The project will be useful:
2222

23-
- 🔰 **Новичкам**для изучения **DevOps**-практик, **GitHub Actions** и контейнеризации
24-
- 🧑‍💻 **Специалистам**как шаблон для построения надёжного и масштабируемого **CI/CD**-процесса
23+
- 🔰 **Beginners**to study **DevOps** practices, **GitHub Actions** and containerization
24+
- 🧑‍💻 **Specialists**as a template for building a reliable and scalable **CI/CD** process

docs/en/10_recommendations.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# 🚀 PROJECT DEVELOPMENT RECOMMENDATIONS
22

33
✅ Add unit tests and integration tests for backend and frontend
4+
45
✅ Implement static code analysis:
56

67
- flake8 or pylint for Python
78
- eslint for Node.js
89

910
✅ Use multi-stage Docker builds to reduce the size of images
11+
1012
✅ Set up deployment to a server or cloud (e.g. Render, Railway, Kubernetes, AWS)
13+
1114
✅ Add HTTPS and automatic SSL certificates using Let's Encrypt ([https://letsencrypt.org/](https://letsencrypt.org/))
15+
1216
✅ Store secrets and configurations via .env files, GitHub Secrets, Docker Compose env_file
17+
1318
✅ Add Healthchecks to docker-compose for backend and frontend to make sure that services are fully operational before nginx is launched
19+
1420
✅ Use a production-ready WSGI server, such as Gunicorn, instead of the built-in Flask server to improve performance and stability

docs/ru/10_recommendations.ru.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11
# 🚀 РЕКОМЕНДАЦИИ ПО РАЗВИТИЮ ПРОЕКТА
22

33
✅ Добавить юнит-тесты и интеграционные тесты для backend и frontend
4+
45
✅ Внедрить статический анализ кода:
56

67
- flake8 или pylint для Python
78
- eslint для Node.js
89

910
✅ Использовать многоэтапную сборку Docker (multi-stage builds) для уменьшения размера образов
11+
1012
✅ Настроить деплой на сервер или в облако (например, Render, Railway, Kubernetes, AWS)
13+
1114
✅ Добавить HTTPS и автоматические SSL-сертификаты с помощью Let's Encrypt ([https://letsencrypt.org/](https://letsencrypt.org/))
15+
1216
✅ Хранить секреты и конфигурации через .env файлы, GitHub Secrets, Docker Compose env_file
17+
1318
✅ Добавить Healthchecks в docker-compose для backend и frontend, чтобы убедиться, что сервисы полностью готовы до запуска nginx
19+
1420
✅ Использовать продакшн-ready WSGI сервер, например Gunicorn вместо встроенного сервера Flask, для повышения производительности и стабильности

docs/ru/README.ru.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
Добро пожаловать! Эта документация описывает проект **CI/CD** с **Docker Hub** и **GitHub Actions**.
44

5-
📚 Для навигации см. [SUMMARY.md](SUMMARY.md)
5+
📚 Для навигации см. [SUMMARY.md](SUMMARY.ru.md)

0 commit comments

Comments
 (0)