WordPress Katkıda Bulunanlar Gutenberg Geliştirici Belgelerini İyileştirmek İçin Sponsorluk İstiyor

WordPress geliştiricileri Milana Cap ve Jonathan Bossenger, Gutenberg geliştirici belgelerini iyileştirmek için bir bağış kampanyası başlatıyor. Konuşma dün Cap, şirketlerin WordPress üzerinde çalışmak için tam zamanlı katkıda bulunanları işe aldığında belgelerin genellikle nasıl gözden kaçırıldığı hakkında tweet attığında başladı.

Cap, "Topluluğunuz yazılımınızı öğrenemediğinde, katkıda bulunanınız olmaz" dedi. "Belgeler ve öğreticiler, Açık Kaynak Yazılım projeleri için insanların düşündüğünden çok daha önemlidir."

Cap, Gutenberg belgelerini ilk kez 2017'de Paris'teki Topluluk Zirvesi'nde istemeye başladı. O zamandan beri topluluğun dikkatini buna yönlendirmeye çalışıyor.

Cap, “Geliştiriciler için blok düzenleyici belgelerinde birçok boşluk var, ancak en belirgin olanı nasıl başlayacağınız” dedi. “Geliştiriciler için belgelerin başlangıcı, başlamak hakkında hiçbir şey söylemez. “Sadece bir blokla neler yapabileceğinizi söylüyor ama _nasıl_ değil. Küçük geliştiriciler, yalnızca PHP geliştiricileri ve bu belgelemeyi ifade eden herkes, bir bloğun kodunun nasıl göründüğünü, nereye yerleştirileceğini, nasıl dahil edileceğini vb. bilmiyor, bırakın özel bileşenlerle özel bir bloğun nasıl oluşturulacağını ve ayarlar."

Blok düzenleyiciyi belgelemenin zorluğunun bir kısmı, aktif geliştirme aşamasında olmasıdır. Geliştirmeler ve iyileştirmeler sürekli olarak Gutenberg eklentisine aktarılır ve şu anda çekirdekte neyin mevcut olup olmadığını takip etmek her zaman kolay değildir. WordPress, yakında blok dizini aramasını başlatacağından, blok oluşturma belgelerini resmileştirmenin tam zamanı.

Cap, "Kod örnekleri tüm belgelerde endişe verici bir şekilde eksik" dedi. “En temel örnekler var ama gerçekten kullanılabilir bir şeyin nasıl oluşturulacağı eksik. Bu nedenle, bu ilk sayfada bir öğreticiye yönlendiriliyoruz, ancak bu öğretici daha önce hiç blok oluşturmamış kişiler için optimize edilmedi. Bunu takiben, bloğu inşa etmeyi başardım ve başaramayacağım.”

Marcus Kazmierczak ve dokümantasyona katkıda bulunanlardan oluşan bir ekip, resmi blok düzenleyici el kitabındaki öğreticiyi yeniden oluşturmaya çalışıyor. Mevcut geliştirici belgelerindeki boşlukları ele almaya odaklanan bir GitHub sorunu, geliştirmeyi engelleme konusunda yeni olan kişiler için belgeleri yeniden yazmanın en iyi yolu hakkında aktif bir tartışmaya ev sahipliği yapıyor.

Cap, "Bu çok iyi bir başlangıç ​​ama daha yapılacak çok iş var" dedi. “Tam belgeler, React ve Gutenberg'i bilen ve anlayan, ancak 'bilgiyle lanetlenmiş' kişiler tarafından yazılmıştır. Başkalarının ne kadar bilmediğini ve hangi ayrıntılı belgelerin yazılması gerektiğini anlamak için harcayacak çok zamanları yok. Dürüst olmak gerekirse, zamanlarını buna harcamaları gerektiğini düşünmüyorum. Bir Dokümantasyon Ekibimiz var ve atlamaya hazırız ama bir çeşit köprü gerekli.”

Gutenberg Geliştirici Belgeleriyle İlgili Sorun: Yeni Gelenler İçin Kolay Değil

Bossenger, "Blok düzenleyici belgelerinde gördüğüm kadarıyla 'sorun', diğer WordPress belgelerinin aksine, deneyimli JavaScript geliştiricileri için yazılması ve yeni başlayanlara yönelik olmamasıdır" dedi. “Ayrıca belirtmeliyim ki, bu hiçbir şekilde mevcut belgeleri bir araya getiren insanlara bir şans değil ve şimdiye kadar yaptıkları tüm çalışmaları takdir ediyorum, sadece ciddi bir gözden geçirme ve biraz iyileştirme ihtiyacı var. ”

Bossenger, geçmişte WordPress'in sınırlı miktarda PHP bilgisi olan herkesin eylem ve filtre kancalarını kullanarak hızlı bir şekilde bir eklenti veya tema oluşturmasını çok kolaylaştırdığını söyledi. Koda bakmak ve ne yapması gerektiğini anlamak kolaydı.

Bossenger, "Modern JavaScript ve özellikle React, çok farklı bir balık su ısıtıcısıdır" dedi. "Yeni terminoloji ve uygulamalar dahil olmak üzere React'in nasıl çalıştığına dair daha derin bir bilgi düzeyi gerektirir. Modern JavaScript de çok kafa karıştırıcı olabilir, özellikle de ok işlevleri veya daha az ayrıntılı if ifadeleri gibi şeyleri ilk kez görüyorsanız.

"WordPress'te JavaScript ile çalışmaya en yakın olan kişi jQuery kullanıyorsa, React tabanlı Gutenberg geliştirmeye geçmek için yine de biraz öğrenmeniz gerekiyor."

Bossenger, biri React diğeri Gutenberg olmak üzere editör için herhangi bir şey inşa etmeden önce iki ders aldıktan sonra, mevcut Block Editor el kitabının React ve modern JavaScript konusunda deneyimi olmayan geliştiriciler için yazılmadığını söyledi. Yeni kavramları daha iyi açıklamak ve yeni gelenlerin tüketmesi daha kolay bir modele uyması için yeniden yapılanmaya ihtiyaç duyduğuna inanıyor. Eklenti Geliştirici el kitabını, bölümlerin bir yapıyı takip ettiği ve daha çok bir ders kitabına benzeyen terminolojiyi kullandığı ve okuyucuyu yavaş yavaş yeni kavramlarla tanıştırdığı bir örnek olarak vurguladı.

Bossenger, "Bu el kitabı ve Google ile donanmış, eklenti veya PHP bilgisi olmayan birinin, özel gereksinimlerini oldukça hızlı bir şekilde karşılamak için basit bir eklenti oluşturmasının oldukça mümkün olacağını iddia ediyorum" dedi. “Şu anda blok düzenleyici el kitabı buna elverişli değil.”

Bossenger, mevcut belgelere ilişkin görüşünde yalnız değil. Delicious Brains'den Peter Tasker, kısa süre önce özel bir Gutenberg bloğu oluşturmaya yönelik bir eğitim yayınladı. Geçen yıl React ile tam zamanlı çalıştıktan sonra bile, resmi blok editör belgelerinin "her yerde" olduğunu ve ayrıştırılması zor buldu.

Cap, dokümantasyon üzerinde tam zamanlı çalışmaya sponsor olan şirketlerin eksikliği hakkında yorum yaptıktan sonra, Bossenger, suları, ikisinin Gutenberg belgelerini geliştirmek için fon toplayıp toplayamayacaklarını soran bir tweet ile test etti.

Cap, "Blok Editör Ekibi (ve diğer herhangi bir Make ekibi gibi) ile aynı şekilde, Dokümantasyon Ekibinde de yeterli personel yok," dedi. “Birkaç üyeyi önce öğrenip sonra blok düzenleyici ile geliştirme üzerine belgeler yazmaya adamaya gücümüz yetmez. Tweetimin asıl sebebi bu. Her yerde sponsorlu katkıda bulunanları göreceksiniz, ancak belgelerde göremeyeceksiniz ve her ikisinin de eşit derecede önemli olduğunu söylemeye cesaret edeceğim.”

Cap ve Bossenger, bağış kampanyalarını başlatmadan önce mevcut belgeleri gözden geçirmeyi, bariz boşlukları tespit etmeyi ve blok editörü için yeni geliştirmeye başlayanlar için cevapsız kalan soruları belirlemeyi planlıyor.

“Bir planımız olduğunda, her parça için ne kadar zamana ihtiyaç olduğunu tahmin edebiliriz” dedi. "Bu planla sponsor arayışına gireceğiz. Bundan önce de bağış yapma seçeneği olacağını düşünüyorum ama bu noktada hiçbir şey kesin değil.”

Bloklar, WordPress geliştirmenin yeni sınırıdır. Yeni başlayanlar için sağlam belgelere ve öğreticilere yatırım yapmak, blok ekosistemini genişletmede büyük bir etkiye sahip olabilir. Bu ayrıca, WordPress sitelerini özelleştirirken aralarından seçim yapabilecekleri daha çeşitli bir blok dizini buldukları için kullanıcılara dolaylı olarak fayda sağlar.

Bossenger ve Cap şu anda bağış kampanyalarını duyurmadan önce dokümanlar için bir plan üzerinde çalışıyor. Bu arada, blok oluşturma belgelerinin geliştirilmesine katkıda bulunmak isteyen herkes GitHub tartışmasına atlayabilir.