SendGrid Belgelerini Düzenleme kolaydır! Bir hata veya yazım hatası görürseniz veya eklemek istediğiniz bir şey varsa önerilerinizi Dokümanlar için kullandığımız içerik yönetim sistemi olan GitHub ile yapabilirsiniz. Önerinizi gönderdikten sonra Dokümanlar ekibi, Dokümanlar web sitesine yayınlanmadan önce kolayca inceleyebilir. https://sendgrid.com/docs adresindeki herhangi bir sayfada değişiklik yapmak için şu adımları izleyin: 1- Düzenlemek istediğiniz sayfaya gidin ve sayfanın altındaki -Bu sayfayı düzenle-'yi tıklayın. Bu sizi sendgrid.com/docs GitHub deposuna veya repo'ya götürecektir. Bu, doküman sayfalarımızın saklandığı yerdir. 2- Eğer bir GitHub hesabınız yoksa, değişiklik önermek için bir tane oluşturmanız gerekir. Bir hesap oluşturmak için sağ üst köşedeki Kayıt bağlantısını tıklayın. Kullanıcı adınızı, şifrenizi ve e-posta adresinizi girin. SendGrid çalışanıysanız, tam adınızı GitHub hesabınızla birlikte kullanın ve SendGrid'i şirketiniz olarak girin, böylece sizi kolayca tanımlayabiliriz. GitHub'da bir Dokümanlar sayfasını görüntüledikten sonra, düzenlemeye başlamak için kurşun kalem simgesini tıklayın. 3- Değişikliklerinizi yaptıktan sonra, Çekme İsteğinde yeni bir şube oluşturma seçeneğine sahip olacaksınız. Bu, orijinal Dokümanlar'ın bir kopyasını veya dalını oluşturma isteğiniz, ancak değişikliklerinizle ilgilidir. Değişiklikleriniz onaylandıktan sonra, şubeniz tekrar orijinaline birleştirilir. 4- Bir Çekme İsteği oluşturmak için bir Taahhüt Değişikliği formu doldurmanız gerekir. Yerleşik şablonu takip edin ve sayfaya yaptığınız tüm değişiklikler hakkında bilgi verin. Varsayılan şube seçeneğini ve adını bırakın. 5- Bittiğinde, Dosya değişikliğini öner'i tıklayın. Dokümanlar Ekibi isteğiniz hakkında bilgilendirilecek. Değişikliği gözden geçirdikten sonra, siteye yayınlayacağız! SendGrid belgelerinin tüm katılımcıları, değişikliklerin birleştirilebilmesi için bir CLA imzalaması gerekir. SendGrid Belgeleri belirli stil kurallarına uymalıdır. Bu yönergelerin birçoğu küçük değişiklikler için geçerli olmasa da, Dokümanlar’nızın aşağıdakilerden emin olmamız önemlidir:
- Özlü
- Doğru
- Organize edilmiş
- Taranabilir Dokümanlar katkıda bulunanlar profesyonel ve “koça benzeyen” bir ses tonu için çabalamalıdır. Belirsiz dil kullanmaktan kaçının ve doğru noktaya ulaşın. Uzun ve aşırı karmaşık açıklamalar, hızlı ve kolay bir cevap isteyen bir kullanıcıya yardımcı olmaz. Lütfen bu stil yönergelerine göre korkmayın. Çoğu küçük değişikliğe uygulanmazlar ve daha önemli değişiklikler yayınlanmadan önce Dokümanlar Ekibi tarafından incelenir ve düzenlenir. Önemli düzenlemeler yapıyorsanız veya yeni içeriğin bir paragrafından fazlasını ekliyorsanız, SendGrid’in Stil Kılavuzu’na başvurmaktan çekinmeyin.