Yeni belgelendirme siteleri oluşturun ve yayınlayın

Bu bölüm, nasıl yeni belgelendirme oluşturulacağını ve docs.fedoraproject.org web sitesinde yayınlanacağını açıklamaktadır. Bu işlemi takip etmeye başlamadan önce Ön koşullar bölümünde listelenen tüm gereksinimleri gözden geçirin.

Yeni bir belgelendirme sitesi oluşturmadan önce e-posta listesine başvurun. Bu, çalışmanızı yayınlayabileceğimizden ve zamanınızı boşa harcamadığınızdan emin olmak içindir.

  1. Şablon depoyu klonlayın: https://pagure.io/fedora-docs/template

  2. Yeni belgelendirme seti için yeni bir pagure deposu oluşturun veya birilerinden sizin için bir tane oluşturmasını isteyin. Yeni depo fedora-docs altında listelenmelidir.

  3. İçerik setiniz için yeni oluşturulan depoyu klonlayın.

  4. Şablon deponun içeriğini (.git dizini olmadan) yeni oluşturulan depoya kopyalayın.

  5. Yeni depoda, depo kök dizinindeki antora.yml yapılandırma dosyasını düzenleyin. Dosya, hangi kısımları değiştirmeniz gerektiğini gösteren yorumlar içermektedir. En azından, name ve title bölümlerini her zaman değiştirin.

  6. Ayrıca, site.yml yapılandırma dosyasını düzenleyin. Bu dosyanın yalnızca içerik setinizin yerel bir ön izlemesini oluştururken kullanıldığını unutmayın - web sitesinde, site geneline ait site.yml yapılandırması tarafından geçersiz kılınmaktadır. Bu dosyada sadece title ve start_page bölümlerini düzenlemeniz gerekmektedir.

  7. Bu noktada, başlangıç yapılandırması tamamlandığında ve depo doğru isim ve gerekli diğer direktiflerle yapılandırıldığında, bu değişiklikleri yeni oluşturulan depoya gönderin (veya doğrudan gönderemezseniz bir çekme isteğinde bulunun). Bu değişiklik seti diğer tüm katkıda bulunmalar için gerekli olacaktır, bu nedenle mümkün olduğunca erken dahil edildiklerinden emin olun.

  8. Güncellemeleri doğrudan göndermemek için yeni deponun bir çatalını oluşturun.

  9. Gerçek ASCIIDoc içeriğini eklemeye başlayın. Yazarken, yeni kaynak dosyalarınızın kullandığınız modülün (öntanımlı olarak ./modules/ROOT/, öncesinde antora.yml dosyasında yapılandırdığınıza göre konum değişecektir) nav.adoc yapılandırma dosyasına dahil edildiğinden emin olun. Ayrıca işaretlemenizi denetlemek için yerel ön izlemeyi sıklıkla kullanın.

  10. İşiniz bittiğinde, değişikliklerinizi kaydedin ve bunları çatalınıza gönderin (commit & push).

  11. Çatal deponuzdan ana deponun master dalına çekme isteği yapmak için Pagure’yi kullanın.

  12. Birisi çekme isteğinizi görecek ve birleştirecek ya da değiştirmeniz gereken bir şey varsa geri bildirim sağlayacaktır. Yaptığınız katkıların standartlara uygun olduğundan emin olmak için yorum yapan kişilerle uyumlu çalışın.

  13. Yeni içeriğinizin ilk kez yayınlanması gerekecektir ve şu anda bu otomatik olarak gerçekleşmemektedir. docs e-posta listesine içeriğinizin yayınlanmasını talep eden bir e-posta gönderin.

5 gün sonra Çekme İsteğinize kimse yanıt vermezse, Belgelendirme Ekibi ile iletişime geçin. Çekme İsteğiniz için gelen e-postayı gözden kaçırmış olabiliriz.