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:
@@ -20,7 +20,9 @@ export default withMermaid(defineConfig({
|
|||||||
{ text: 'Home', link: '/en/' },
|
{ text: 'Home', link: '/en/' },
|
||||||
{ text: 'Guides', link: '/en/guides/getting-started' },
|
{ text: 'Guides', link: '/en/guides/getting-started' },
|
||||||
{ text: 'Architecture', link: '/en/architecture/system-design' },
|
{ text: 'Architecture', link: '/en/architecture/system-design' },
|
||||||
{ text: 'Templates', link: '/en/templates/' }
|
{ text: 'Templates', link: '/en/templates/' },
|
||||||
|
{ text: 'Skills', link: '/en/skills/' },
|
||||||
|
{ text: 'Runbooks', link: '/en/runbooks/' }
|
||||||
],
|
],
|
||||||
sidebar: {
|
sidebar: {
|
||||||
'/en/guides/': [
|
'/en/guides/': [
|
||||||
@@ -69,6 +71,50 @@ export default withMermaid(defineConfig({
|
|||||||
{ text: 'Skill Pattern', link: '/en/templates/skill-pattern' }
|
{ text: 'Skill Pattern', link: '/en/templates/skill-pattern' }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
],
|
||||||
|
'/en/skills/': [
|
||||||
|
{
|
||||||
|
text: 'Skills',
|
||||||
|
items: [
|
||||||
|
{ text: 'Overview', link: '/en/skills/' },
|
||||||
|
{ text: 'API Design', link: '/en/skills/api-design' },
|
||||||
|
{ text: 'API Gateway', link: '/en/skills/api-gateway-advanced' },
|
||||||
|
{ text: 'API Versioning', link: '/en/skills/api-versioning-strategy' },
|
||||||
|
{ text: 'Caching Patterns', link: '/en/skills/caching-patterns' },
|
||||||
|
{ text: 'CI/CD Patterns', link: '/en/skills/cicd-advanced-patterns' },
|
||||||
|
{ text: 'Code Comments', link: '/en/skills/comment-code' },
|
||||||
|
{ text: 'Configuration', link: '/en/skills/configuration-management' },
|
||||||
|
{ text: 'Data Consistency', link: '/en/skills/data-consistency-patterns' },
|
||||||
|
{ text: 'Database Prisma', link: '/en/skills/database-prisma' },
|
||||||
|
{ text: 'Deployment K8s', link: '/en/skills/deployment-kubernetes' },
|
||||||
|
{ text: 'Documentation', link: '/en/skills/documentation' },
|
||||||
|
{ text: 'Error Handling', link: '/en/skills/error-handling-patterns' },
|
||||||
|
{ text: 'Event-Driven', link: '/en/skills/event-driven-architecture' },
|
||||||
|
{ text: 'Infrastructure', link: '/en/skills/infrastructure-as-code' },
|
||||||
|
{ text: 'Inter-Service Comm', link: '/en/skills/inter-service-communication' },
|
||||||
|
{ text: 'Microservices Dev', link: '/en/skills/microservices-development-process' },
|
||||||
|
{ text: 'Middleware', link: '/en/skills/middleware-patterns' },
|
||||||
|
{ text: 'Observability', link: '/en/skills/observability-monitoring' },
|
||||||
|
{ text: 'Performance', link: '/en/skills/performance-optimization' },
|
||||||
|
{ text: 'Project Rules', link: '/en/skills/project-rules' },
|
||||||
|
{ text: 'Repository Pattern', link: '/en/skills/repository-pattern' },
|
||||||
|
{ text: 'Resilience', link: '/en/skills/resilience-patterns' },
|
||||||
|
{ text: 'Security', link: '/en/skills/security' },
|
||||||
|
{ text: 'Service Discovery', link: '/en/skills/service-discovery-registry' },
|
||||||
|
{ text: 'Service Layer', link: '/en/skills/service-layer-patterns' },
|
||||||
|
{ text: 'Testing', link: '/en/skills/testing-patterns' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/en/runbooks/': [
|
||||||
|
{
|
||||||
|
text: 'Runbooks',
|
||||||
|
items: [
|
||||||
|
{ text: 'Overview', link: '/en/runbooks/' },
|
||||||
|
{ text: 'Incident Response', link: '/en/runbooks/incident-response' },
|
||||||
|
{ text: 'Rollback Procedure', link: '/en/runbooks/rollback-procedure' }
|
||||||
|
]
|
||||||
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -82,7 +128,9 @@ export default withMermaid(defineConfig({
|
|||||||
{ text: 'Trang chủ', link: '/vi/' },
|
{ text: 'Trang chủ', link: '/vi/' },
|
||||||
{ text: 'Hướng dẫn', link: '/vi/guides/getting-started' },
|
{ text: 'Hướng dẫn', link: '/vi/guides/getting-started' },
|
||||||
{ text: 'Kiến trúc', link: '/vi/architecture/system-design' },
|
{ text: 'Kiến trúc', link: '/vi/architecture/system-design' },
|
||||||
{ text: 'Templates', link: '/vi/templates/' }
|
{ text: 'Templates', link: '/vi/templates/' },
|
||||||
|
{ text: 'Skills', link: '/vi/skills/' },
|
||||||
|
{ text: 'Runbooks', link: '/vi/runbooks/' }
|
||||||
],
|
],
|
||||||
sidebar: {
|
sidebar: {
|
||||||
'/vi/guides/': [
|
'/vi/guides/': [
|
||||||
@@ -131,6 +179,50 @@ export default withMermaid(defineConfig({
|
|||||||
{ text: 'Skill Pattern', link: '/vi/templates/skill-pattern' }
|
{ text: 'Skill Pattern', link: '/vi/templates/skill-pattern' }
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
],
|
||||||
|
'/vi/skills/': [
|
||||||
|
{
|
||||||
|
text: 'Skills',
|
||||||
|
items: [
|
||||||
|
{ text: 'Tổng quan', link: '/vi/skills/' },
|
||||||
|
{ text: 'API Design', link: '/vi/skills/api-design' },
|
||||||
|
{ text: 'API Gateway', link: '/vi/skills/api-gateway-advanced' },
|
||||||
|
{ text: 'API Versioning', link: '/vi/skills/api-versioning-strategy' },
|
||||||
|
{ text: 'Caching Patterns', link: '/vi/skills/caching-patterns' },
|
||||||
|
{ text: 'CI/CD Patterns', link: '/vi/skills/cicd-advanced-patterns' },
|
||||||
|
{ text: 'Code Comments', link: '/vi/skills/comment-code' },
|
||||||
|
{ text: 'Configuration', link: '/vi/skills/configuration-management' },
|
||||||
|
{ text: 'Data Consistency', link: '/vi/skills/data-consistency-patterns' },
|
||||||
|
{ text: 'Database Prisma', link: '/vi/skills/database-prisma' },
|
||||||
|
{ text: 'Deployment K8s', link: '/vi/skills/deployment-kubernetes' },
|
||||||
|
{ text: 'Documentation', link: '/vi/skills/documentation' },
|
||||||
|
{ text: 'Error Handling', link: '/vi/skills/error-handling-patterns' },
|
||||||
|
{ text: 'Event-Driven', link: '/vi/skills/event-driven-architecture' },
|
||||||
|
{ text: 'Infrastructure', link: '/vi/skills/infrastructure-as-code' },
|
||||||
|
{ text: 'Inter-Service Comm', link: '/vi/skills/inter-service-communication' },
|
||||||
|
{ text: 'Microservices Dev', link: '/vi/skills/microservices-development-process' },
|
||||||
|
{ text: 'Middleware', link: '/vi/skills/middleware-patterns' },
|
||||||
|
{ text: 'Observability', link: '/vi/skills/observability-monitoring' },
|
||||||
|
{ text: 'Performance', link: '/vi/skills/performance-optimization' },
|
||||||
|
{ text: 'Project Rules', link: '/vi/skills/project-rules' },
|
||||||
|
{ text: 'Repository Pattern', link: '/vi/skills/repository-pattern' },
|
||||||
|
{ text: 'Resilience', link: '/vi/skills/resilience-patterns' },
|
||||||
|
{ text: 'Security', link: '/vi/skills/security' },
|
||||||
|
{ text: 'Service Discovery', link: '/vi/skills/service-discovery-registry' },
|
||||||
|
{ text: 'Service Layer', link: '/vi/skills/service-layer-patterns' },
|
||||||
|
{ text: 'Testing', link: '/vi/skills/testing-patterns' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
'/vi/runbooks/': [
|
||||||
|
{
|
||||||
|
text: 'Runbooks',
|
||||||
|
items: [
|
||||||
|
{ text: 'Tổng quan', link: '/vi/runbooks/' },
|
||||||
|
{ text: 'Xử lý sự cố', link: '/vi/runbooks/incident-response' },
|
||||||
|
{ text: 'Quy trình Rollback', link: '/vi/runbooks/rollback-procedure' }
|
||||||
|
]
|
||||||
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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