Skip to content

İçerik Katkı Süreci — Ekip Üyesi Ekleme

Bu sayfa, ekip üyelerinin (teknisyenler, bilgi@sbsolar.com.tr gibi) dokümantasyon sitesine (bu site) nasıl katkı verebileceğini, ve bunun nasıl admin onayından geçtiğini açıklar.

Kimler için

Bu süreç GitHub hesabı olan, git/markdown kullanabilen ekip üyeleri içindir (teknisyenler gibi). Teknik olmayan son kullanıcılardan (karavan sahipleri, müşteriler) içerik katkısı beklenmiyor — onlar için ayrı bir form/CMS kurulmadı, şu an gerek görülmedi.

Kurulum — bir ekip üyesi eklemek

  1. GitHub'da synyalsal/sbsolar-docs reposuna gidin → SettingsCollaborators.
  2. Kişinin GitHub kullanıcı adını/email'ini ekleyin, rol olarak "Write" verin. Bu rol repoyu silmelerine ya da ayar değiştirmelerine izin vermez — sadece branch açıp Pull Request gönderebilirler.

Katkı akışı — ekip üyesinin yapacakları

  1. Repoyu klonlar, yeni bir branch açar:
    git checkout -b yeni-sayfa
  2. docs/ altında bir markdown dosyası düzenler ya da yeni bir tane ekler.
  3. Yeni bir sayfa ekliyorsa, docs/.vitepress/config.ts'deki nav ve/veya sidebar alanına da bir link eklemesi gerekir (yoksa sayfa var olur ama menüden erişilemez).
  4. Değişikliği push eder:
    git push origin yeni-sayfa
  5. GitHub'da "Compare & pull request" butonuna basıp bir Pull Request (PR) açar.

Onay akışı — admin (siz) yapacaklar

  1. GitHub'daki Pull requests sekmesinden yeni PR'ı görürsünüz.
  2. Files changed sekmesinden diff'i (neyin değiştiğini) incelersiniz. İsterseniz satır satır yorum bırakabilirsiniz.
  3. Uygunsa "Merge pull request" butonuna basarsınız.
  4. Merge olduğu anda Cloudflare Pages otomatik olarak yeni bir build tetikler — birkaç dakika içinde site güncellenir, ekstra bir işlem gerekmez.

Reddetmek isterseniz PR'ı kapatabilir ya da değişiklik isteyebilirsiniz — hiçbir şey admin onayı olmadan master branch'ine (dolayısıyla canlı siteye) yansımaz.

Branch protection (henüz kurulmadı)

Şu anki durumda bu süreç anlaşma/disiplin ile işliyor — teknik olarak yazma erişimi olan biri isterse doğrudan master'a push edebilir, PR akışı zorunlu değil.

GitHub'ın Branch Protection özelliği bunu teknik olarak zorunlu kılabilir (kimse — admin dahil — PR + en az 1 onay olmadan master'a yazamaz). Ekip büyüyünce ya da gerek görülünce kurulmalı — GitHub repo Settings → Branches → Add rule → master → "Require a pull request before merging" seçeneğiyle tek adımda etkinleşir.

Yeni sayfa eklerken hatırlatma

  • Dosya docs/ altına, .md uzantılı olarak eklenir.
  • VitePress dosya yolunu otomatik route'a çevirir (docs/ornek.md/ornek).
  • public/ klasör adı VitePress'te özel bir anlam taşır (statik dosyalar için ayrılmış) — sayfa içeriği için kullanılmamalı, bu yüzden bu sitede tüm sayfalar kökte (docs/*.md) ya da internal/ altında tutuluyor.
  • Şirket içi (herkese açık olmayan) içerik docs/internal/ altına eklenmeli — bu klasör Cloudflare Access ile korunuyor.

SB Solar WiFi BMS İnverter Monitor