Lewati ke isi

Deployment Situs Dokumentasi — docs.gcgscola.id

Last verified: 2026-06-11
URL produksi: https://docs.gcgscola.id
Stack: MkDocs Material → static HTML → nginx

1. Rekomendasi Subdomain

Subdomain Rekomendasi Keterangan
docs.gcgscola.id Utama (dipakai) Standar industri; cocok untuk implementator + end user + teknis
help.gcgscola.id Alternatif Lebih “user-facing”; bisa redirect ke docs nanti
panduan.gcgscola.id Opsional Bahasa Indonesia; kurang familiar untuk integrasi

DNS Cloudflare: buat record A atau CNAME → IP server ini (sama seperti dev.gcgscola.id), Proxy ON (orange cloud) disarankan.

2. Arsitektur

scola-fe-v2/docs/*.md  →  mkdocs build  →  /var/www/docs.gcgscola.id/  →  nginx  →  Cloudflare  →  pengguna

SSOT tetap markdown di repo; situs web hanya hasil build.

3. Build & Deploy (server)

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

Tanpa --install: hanya generate ke folder site/ lokal.

4. Nginx (pertama kali)

Setelah DNS docs.gcgscola.id mengarah ke server:

# 1. Deploy static files
./scripts/build-docs.sh --install

# 2. Aktifkan vhost HTTP (untuk ACME)
sudo cp /home/scola/odoo/config/nginx/docs.gcgscola.id.http-only.conf \
  /etc/nginx/sites-enabled/docs.gcgscola.id
sudo nginx -t && sudo systemctl reload nginx

# 3. SSL Let's Encrypt
sudo certbot --nginx -d docs.gcgscola.id

# 4. Verifikasi
curl -I https://docs.gcgscola.id

Template HTTPS penuh: /home/scola/odoo/config/nginx/docs.gcgscola.id.conf

5. Update Dokumentasi

Setelah edit markdown di docs/:

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

Tidak perlu restart nginx (file statis).

6. Cloudflare

  • SSL/TLS: Full (strict) setelah certbot aktif di origin
  • Cache: default OK; HTML / sudah no-cache di nginx
  • Access (opsional): rencana dokumen internal bisa pakai Cloudflare Access di path /audit/ — belum diaktifkan default

7. File Terkait

File Fungsi
mkdocs.yml Navigasi & tema situs
requirements-docs.txt Dependency Python MkDocs
scripts/build-docs.sh Build + rsync deploy
docs/index.md Halaman beranda portal