Skip to content

Commit 3ef8fda

Browse files
committed
Add additional documentation files
- Add deployment workflow documentation - Add quick reference guide for team - Complete documentation suite for manual deployment system
1 parent 93c958b commit 3ef8fda

2 files changed

Lines changed: 127 additions & 0 deletions

File tree

docs/DEPLOYMENT_WORKFLOW.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Deployment Workflow - www.konxc.space
2+
3+
## 📊 Workflow Diagram
4+
5+
```
6+
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
7+
│ Developer │ │ Main Branch │ │ Deploy Script │
8+
│ │ │ │ │ │
9+
│ 1. Make Changes │───▶│ 2. Commit & Push │───▶│ 3. Run Script │
10+
│ │ │ │ │ │
11+
└─────────────────┘ └──────────────────┘ └─────────────────┘
12+
13+
14+
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
15+
│ GitHub Pages │◀───│ gh-pages │◀───│ 4. Build & │
16+
│ │ │ Branch │ │ Deploy │
17+
│ 6. Live Website │ │ 5. Push Files │ │ │
18+
│ │ │ │ │ │
19+
└─────────────────┘ └──────────────────┘ └─────────────────┘
20+
```
21+
22+
## 🔄 Detailed Process
23+
24+
### 1. Development Phase
25+
- Developer membuat perubahan di branch `main`
26+
- Test lokal menggunakan `pnpm dev`
27+
- Commit dan push perubahan ke repository
28+
29+
### 2. Deployment Phase
30+
- Jalankan script deploy manual: `./scripts/deploy-manual.sh`
31+
- Script akan:
32+
- Pull latest changes dari main
33+
- Install dependencies dengan pnpm
34+
- Build project dengan Astro
35+
- Switch ke branch gh-pages
36+
- Copy built files ke root
37+
- Commit dan push ke gh-pages branch
38+
39+
### 3. GitHub Pages Deployment
40+
- GitHub Pages otomatis detect perubahan di branch gh-pages
41+
- Website di-deploy ke https://www.konxc.space
42+
- Proses ini membutuhkan waktu 2-5 menit
43+
44+
## 🎯 Key Benefits
45+
46+
1. **No Billing Issues**: Tidak menggunakan GitHub Actions
47+
2. **Manual Control**: Developer memiliki kontrol penuh atas deployment
48+
3. **Reliable**: Script yang sederhana dan dapat diandalkan
49+
4. **Cross-Platform**: Support Linux, macOS, dan Windows
50+
5. **Documentation**: Dokumentasi lengkap untuk tim
51+
52+
## ⚠️ Important Notes
53+
54+
- **Branch Separation**: Main untuk development, gh-pages untuk deployment
55+
- **Manual Process**: Deployment harus dilakukan secara manual
56+
- **Script Dependency**: Pastikan pnpm dan Node.js terinstall
57+
- **Timing**: GitHub Pages butuh waktu untuk update
58+
59+
## 🛠️ Maintenance
60+
61+
- Script dapat diupdate sesuai kebutuhan
62+
- Dokumentasi harus selalu up-to-date
63+
- Tim harus familiar dengan proses manual deployment
64+
- Backup penting dilakukan secara teratur

docs/QUICK_REFERENCE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Quick Reference - www.konxc.space
2+
3+
## 🚀 Quick Deploy Commands
4+
5+
```bash
6+
# Linux/macOS
7+
./scripts/deploy-manual.sh
8+
9+
# Windows (Git Bash/WSL)
10+
./scripts/deploy-manual.bat
11+
12+
# Manual (if scripts fail)
13+
git checkout main && git pull origin main
14+
pnpm install && pnpm run build
15+
git checkout gh-pages && cp -r dist/* .
16+
git add . && git commit -m "Deploy: $(date)"
17+
git push origin gh-pages && git checkout main
18+
```
19+
20+
## 🔧 Development Commands
21+
22+
```bash
23+
pnpm dev # Start development server
24+
pnpm build # Build for production
25+
pnpm preview # Preview build locally
26+
pnpm install # Install dependencies
27+
```
28+
29+
## 📁 Important Files
30+
31+
- `scripts/deploy-manual.sh` - Deploy script (Linux/macOS)
32+
- `scripts/deploy-manual.bat` - Deploy script (Windows)
33+
- `docs/DEPLOY_MANUAL.md` - Detailed deployment guide
34+
- `docs/TROUBLESHOOTING.md` - Common issues and solutions
35+
- `docs/MAINTENANCE_CHECKLIST.md` - Maintenance tasks
36+
37+
## 🌐 URLs
38+
39+
- **Live Site**: https://www.konxc.space
40+
- **Repository**: https://github.com/konxc/konxc.github.io
41+
- **Development**: http://localhost:4321
42+
43+
## ⚡ Emergency Contacts
44+
45+
- Repository Issues: Create GitHub issue
46+
- Website Down: Check GitHub Pages status
47+
- Build Errors: See troubleshooting guide
48+
49+
## 📋 Pre-Deploy Checklist
50+
51+
- [ ] Changes committed to main
52+
- [ ] Local build successful
53+
- [ ] pnpm and Node.js installed
54+
- [ ] Internet connection stable
55+
- [ ] Ready to deploy
56+
57+
## 🎯 Post-Deploy Verification
58+
59+
- [ ] Check https://www.konxc.space
60+
- [ ] Test key functionality
61+
- [ ] Verify all pages load
62+
- [ ] Check mobile responsiveness
63+
- [ ] Wait 5-10 minutes for full deployment

0 commit comments

Comments
 (0)