Panduan Publish ke Portal End User¶

Cara menyinkronkan dokumentasi dari repo ke portal web https://docs.gcgscola.id (MkDocs Material di server).

Last verified: 2026-06-11
URL live: https://docs.gcgscola.id
Deploy: lihat docs-site-deployment.md

1. Prinsip¶

SSOT teknis: scola-fe-v2/docs/ di repo
Portal end user: mirror ringkas, non-teknis, dengan screenshot
Jangan tulis kontrak API hanya di portal — selalu link ke repo untuk implementor

2. Struktur Portal (mirror role tiers)¶

Beranda
├── Memulai (login, navigasi, FAQ)
├── Tier 1: Eksekutif
│   ├── Kepala Sekolah
│   └── Ketua Yayasan
├── Tier 2: Manajemen
│   ├── Wakil Kepala Sekolah
│   └── Kepala TU
├── Tier 3: Operasional
│   ├── Guru, Wali Kelas, BK, Bendahara, Staff TU, Pustakawan, Laboran
├── Tier 4: Portal
│   ├── Siswa, Orang Tua, Alumni
├── Quick Start (workflow inti)
├── FAQ
└── Glosarium

3. Sumber File Repo¶

Konten portal	Sumber repo
Panduan per role	`docs/user-guide/per-role/*.md`
Quick Start	`docs/user-guide/quick-start/*.md`
FAQ	`docs/user-guide/faq.md`
Glosarium	`docs/user-guide/glossary.md`
Login & navigasi umum	`docs/user-guide/README.md`

4. Workflow Publish (mingguan)¶

Edit markdown di repo scola-fe-v2/docs/ (PR review)
Merge ke develop

Di server, jalankan:

cd /home/scola/odoo/scola-fe-v2
./scripts/build-docs.sh --install

Tambahkan screenshot setelah UI stabil (folder docs/user-guide/assets/)
Buka https://docs.gcgscola.id dan verifikasi halaman ter-update

Alternatif eksternal: GitBook/Notion tetap bisa mirror subset user-guide/ jika klien minta portal terpisah bermerek sekolah.

5. Checklist per Halaman Portal¶

[ ] Bahasa Indonesia, non-teknis
[ ] Langkah bernomor dengan path menu yang benar
[ ] Screenshot area yang relevan (opsional fase awal)
[ ] Link ke FAQ untuk error umum
[ ] Tanggal "Terakhir diperbarui"

6. Role Prioritas Professional (publish dulu)¶

admin-staff
teacher
homeroom
student
parent
librarian

Role lain (principal, counselor, treasurer, dll.) bisa menyusul atau ringkas jika tidak dipakai klien pertama.