admin/pos-system
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(docs): Enhance deployment guides with improved formatting and visual elements

Browse Source 
- Updated the introductory notes in both English and Vietnamese deployment guides for clarity.
- Changed subgraph titles in Mermaid diagrams for consistency and improved readability.
- Added color styling to Mermaid diagram elements for better visual distinction.
This commit is contained in:
Ho Ngoc Hai
2026-01-08 15:45:18 +07:00
parent 510e2306cd
commit 3f5d9715dc
4 changed files with 41 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.agent/workflows/docs-edit-vi-en.md Normal file
View File

@@ -0,0 +1,10 @@
---
description: Workflows chỉnh sửa docs
---
1. Xóa các comment "# EN: ..." trong code blocks
2. Kiểm tra và sửa các diagram Mermaid (xóa , thay & bằng và)
3. Áp dụng bảng màu tối chuẩn
4. Làm cho nội dung thuần Việt hơn với phiên bản vi
5. Sau khi chỉnh sửa xong phiên bản Việt, hãy cập nhật phiên bản tiếng anh

1
apps/web-docs/src/lib/docs-generator.ts
View File

@@ -36,6 +36,7 @@ const ITEM_ORDER: Record<string, string[]> = {
'guides': [
'getting-started', // EN: Always show getting started first / VI: Luôn hiển thị getting started đầu tiên
'local-development', // EN: Then local setup / VI: Sau đó là local setup
'development', // EN: Then development / VI: Sau đó là development
'deployment', // EN: Then deployment / VI: Sau đó là deployment
// EN: Other items will be alphabetically sorted / VI: Các items khác sẽ được sắp xếp theo alphabet
],

18
docs/en/guides/deployment.md
View File

@@ -1,6 +1,6 @@
# Deployment Guide
> **Note**: This guide covers deployment strategies for GoodGo Microservices Platform across Local, Staging, and Production environments using Kubernetes and Neon PostgreSQL.
>Deployment strategies for GoodGo Microservices Platform across Local, Staging, and Production environments using Kubernetes and Neon PostgreSQL
## Table of Contents
@@ -20,14 +20,14 @@
```mermaid
graph TD
subgraph "CI/CD Pipeline (GitHub Actions)"
subgraph "CI/CD Pipeline - GitHub Actions"
Code[Code Push] --> Test[Run Tests]
Test --> Build[Build Docker Image]
Build --> Registry[Push to Registry]
Registry --> Deploy[Deploy to K8s]
end
subgraph "Infrastructure (Kubernetes)"
subgraph "Infrastructure - Kubernetes"
Ingress[Traefik Ingress] --> Service[K8s Service]
Service --> Pods[Application Pods]
Pods --> Secrets[K8s Secrets]
@@ -39,6 +39,18 @@ graph TD
end
Deploy --> Ingress
style Code fill:#3498DB,color:#fff
style Test fill:#27AE60,color:#fff
style Build fill:#2980B9,color:#fff
style Registry fill:#8E44AD,color:#fff
style Deploy fill:#E67E22,color:#fff
style Ingress fill:#2980B9,color:#fff
style Service fill:#3498DB,color:#fff
style Pods fill:#27AE60,color:#fff
style Secrets fill:#E67E22,color:#fff
style Neon fill:#8E44AD,color:#fff
style Redis fill:#F39C12,color:#fff
```
---

18
docs/vi/guides/deployment.md
View File

@@ -1,6 +1,6 @@
# Hướng Dẫn Deployment
> **Lưu ý**: Hướng dẫn này bao gồm các chiến lược deployment cho GoodGo Microservices Platform trên các môi trường Local, Staging, và Production sử dụng Kubernetes và Neon PostgreSQL.
>Hướng dẫn deployment cho GoodGo Microservices Platform trên các môi trường Local, Staging, và Production sử dụng Kubernetes và Neon PostgreSQL
## Mục lục
@@ -20,14 +20,14 @@
```mermaid
graph TD
subgraph "CI/CD Pipeline (GitHub Actions)"
subgraph "CI/CD Pipeline - GitHub Actions"
Code[Code Push] --> Test[Run Tests]
Test --> Build[Build Docker Image]
Build --> Registry[Push to Registry]
Registry --> Deploy[Deploy to K8s]
end
subgraph "Infrastructure (Kubernetes)"
subgraph "Infrastructure - Kubernetes"
Ingress[Traefik Ingress] --> Service[K8s Service]
Service --> Pods[Application Pods]
Pods --> Secrets[K8s Secrets]
@@ -39,6 +39,18 @@ graph TD
end
Deploy --> Ingress
style Code fill:#3498DB,color:#fff
style Test fill:#27AE60,color:#fff
style Build fill:#2980B9,color:#fff
style Registry fill:#8E44AD,color:#fff
style Deploy fill:#E67E22,color:#fff
style Ingress fill:#2980B9,color:#fff
style Service fill:#3498DB,color:#fff
style Pods fill:#27AE60,color:#fff
style Secrets fill:#E67E22,color:#fff
style Neon fill:#8E44AD,color:#fff
style Redis fill:#F39C12,color:#fff
```
---