feat(docs): Expand skills and runbooks sections in VitePress configuration
- Added new 'Skills' and 'Runbooks' sections to both English and Vietnamese documentation, enhancing the navigation structure. - Included detailed items under the 'Skills' section, covering various topics such as API Design, Caching Patterns, and Testing Patterns. - Updated sidebar configurations to improve user experience and accessibility of resources. - Removed outdated onboarding guides to streamline documentation and focus on relevant content.
This commit is contained in:
Ho Ngoc Hai
@@ -1,89 +0,0 @@
|
||||
# New Developer Guide
|
||||
|
||||
Welcome to VelikHo's Microservices Platform project!
|
||||
|
||||
## First Day Checklist
|
||||
|
||||
- [ ] Access to GitHub repository
|
||||
- [ ] Access to development environment
|
||||
- [ ] Docker installed and running
|
||||
- [ ] Node.js and PNPM installed
|
||||
- [ ] IDE configured (VS Code recommended)
|
||||
- [ ] Read this guide
|
||||
|
||||
## Setup Your Development Environment
|
||||
|
||||
1. **Clone the repository**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd Base
|
||||
```
|
||||
|
||||
2. **Run initialization script**
|
||||
```bash
|
||||
./scripts/setup/init-project.sh
|
||||
```
|
||||
|
||||
3. **Start local infrastructure**
|
||||
```bash
|
||||
cd deployments/local
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
4. **Verify setup**
|
||||
- Check Traefik: http://localhost:8080
|
||||
- Check API: http://localhost/api/v1/health
|
||||
|
||||
## Development Tools
|
||||
|
||||
### Recommended VS Code Extensions
|
||||
|
||||
- ESLint
|
||||
- Prettier
|
||||
- Prisma
|
||||
- Docker
|
||||
- GitLens
|
||||
|
||||
### Useful Commands
|
||||
|
||||
```bash
|
||||
# Start all services
|
||||
./scripts/dev/start-all.sh
|
||||
|
||||
# Start specific service
|
||||
./scripts/dev/start-service.sh iam-service
|
||||
|
||||
# View logs
|
||||
./scripts/dev/logs.sh iam-service
|
||||
|
||||
# Run migrations
|
||||
./scripts/db/migrate.sh iam-service dev
|
||||
|
||||
# Run tests
|
||||
pnpm test
|
||||
```
|
||||
|
||||
## Code Standards
|
||||
|
||||
- **TypeScript**: Strict mode enabled
|
||||
- **Linting**: ESLint with shared config
|
||||
- **Formatting**: Prettier
|
||||
- **Commits**: Conventional Commits format
|
||||
- **Tests**: Minimum 80% coverage
|
||||
|
||||
## Getting Help
|
||||
|
||||
- Check [Documentation](../guides/)
|
||||
- Contact maintainer: hongochai10@icloud.com
|
||||
- Review existing code examples
|
||||
- Open an issue on GitHub
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Pick a small task from backlog
|
||||
2. Create feature branch
|
||||
3. Implement and test
|
||||
4. Create pull request
|
||||
5. Get code review
|
||||
|
||||
Good luck! 🚀
|
||||
8
docs/en/runbooks/index.md
Normal file
8
docs/en/runbooks/index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Runbooks
|
||||
|
||||
Operational runbooks for incident response and common procedures.
|
||||
|
||||
## Available Runbooks
|
||||
|
||||
- [Incident Response](./incident-response) - How to handle production incidents
|
||||
- [Rollback Procedure](./rollback-procedure) - How to safely rollback deployments
|
||||
@@ -1,89 +0,0 @@
|
||||
# Hướng Dẫn Cho Developer Mới
|
||||
|
||||
Chào mừng đến với team GoodGo Microservices Platform!
|
||||
|
||||
## Checklist Ngày Đầu Tiên
|
||||
|
||||
- [ ] Quyền truy cập GitHub repository
|
||||
- [ ] Quyền truy cập môi trường development
|
||||
- [ ] Docker đã cài đặt và đang chạy
|
||||
- [ ] Node.js và PNPM đã cài đặt
|
||||
- [ ] IDE đã cấu hình (khuyến nghị VS Code)
|
||||
- [ ] Đã đọc hướng dẫn này
|
||||
|
||||
## Thiết Lập Môi Trường Development
|
||||
|
||||
1. **Clone repository**
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
cd Base
|
||||
```
|
||||
|
||||
2. **Chạy script khởi tạo**
|
||||
```bash
|
||||
./scripts/setup/init-project.sh
|
||||
```
|
||||
|
||||
3. **Khởi động infrastructure local**
|
||||
```bash
|
||||
cd deployments/local
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
4. **Xác minh setup**
|
||||
- Kiểm tra Traefik: http://localhost:8080
|
||||
- Kiểm tra API: http://localhost/api/v1/health
|
||||
|
||||
## Công Cụ Development
|
||||
|
||||
### VS Code Extensions Khuyến Nghị
|
||||
|
||||
- ESLint
|
||||
- Prettier
|
||||
- Prisma
|
||||
- Docker
|
||||
- GitLens
|
||||
|
||||
### Các Lệnh Hữu Ích
|
||||
|
||||
```bash
|
||||
# Khởi động tất cả services
|
||||
./scripts/dev/start-all.sh
|
||||
|
||||
# Khởi động service cụ thể
|
||||
./scripts/dev/start-service.sh iam-service
|
||||
|
||||
# Xem logs
|
||||
./scripts/dev/logs.sh iam-service
|
||||
|
||||
# Chạy migrations
|
||||
./scripts/db/migrate.sh iam-service dev
|
||||
|
||||
# Chạy tests
|
||||
pnpm test
|
||||
```
|
||||
|
||||
## Tiêu Chuẩn Code
|
||||
|
||||
- **TypeScript**: Bật strict mode
|
||||
- **Linting**: ESLint với shared config
|
||||
- **Formatting**: Prettier
|
||||
- **Commits**: Định dạng Conventional Commits
|
||||
- **Tests**: Tối thiểu 80% coverage
|
||||
|
||||
## Tìm Kiếm Trợ Giúp
|
||||
|
||||
- Xem [Tài Liệu](../guides/)
|
||||
- Hỏi trong Slack channel của team
|
||||
- Xem lại các ví dụ code hiện có
|
||||
- Pair với senior developer
|
||||
|
||||
## Các Bước Tiếp Theo
|
||||
|
||||
1. Chọn một task nhỏ từ backlog
|
||||
2. Tạo feature branch
|
||||
3. Implement và test
|
||||
4. Tạo pull request
|
||||
5. Nhận code review
|
||||
|
||||
Chúc may mắn! 🚀
|
||||
8
docs/vi/runbooks/index.md
Normal file
8
docs/vi/runbooks/index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Runbooks
|
||||
|
||||
Runbooks vận hành cho xử lý sự cố và các quy trình phổ biến.
|
||||
|
||||
## Runbooks có sẵn
|
||||
|
||||
- [Xử lý sự cố](./incident-response) - Cách xử lý các sự cố production
|
||||
- [Quy trình Rollback](./rollback-procedure) - Cách rollback deployments an toàn
|
||||
Reference in New Issue
Block a user