GenPipes projesi

Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.

Proje özeti

Açık kaynak kuruluşu:
GenPipes
Teknik yazar:
shaloo
Projenin adı:
"Dokümanları Okuyun" bölümünde GenPipes dokümanlarını oluşturun
Proje süresi:
Standart uzunluk (3 ay)

Proje açıklaması

"Belgeleri Okuyun" konusunda GenPipes dokümanları oluşturma hedefine ulaşmak için 3 adımlı bir plan öneriyorum.

1. Adım: İlgili Kişi

  • Yeni bir kullanıcı / araştırmacı olarak GenPipes'in mevcut dokümanlarını inceleyin

    • Eksik bilgileri veya yanlışlıkları tanımlayın
    • Yeni doküman konuları önerin (gerekirse)
    • Hedef kitleye yönelik, yeni kullanıcılara odaklanan taslak bilgi mimarisi haritası.

    (Not: Bu adımda, RTD için genpipes belgelerinin barındırılabileceği yeni bir GitHub deposu kurulumuyla ilgili olarak GenPipes mentorlarının girişlerine de ihtiyaç duyabiliriz. Bu GitHub deposu, RTD derleme ardışık düzenlerindeki tüm belgeleri içe aktarmak için kullanılabilir. Bu işlem için, uyulması gerekiyorsa GenPipes deposu kuralları ve doküman kaynağı yönetimi yönergeleri hakkında analizler gerekebilir. Aksi takdirde standart olanlar kullanılabilir. Ayrıca, ilgili kişi için GitHub hesabımı kullanarak örnek bir RTD deposu kurulumunun demosunu yapabilirim. Örneğin, https://gpdocs.readthedocs.io/en/latest/. Bu, bu teklif için oluşturduğum bir örnekleyicidir.)

  • Önceki adımdaki inceleme ve analize göre, önerilen GenPipes Belgeleme yapısını / dizinini içeren sağlam bir iskelet oluşturun ve bunu RTD sitesine yerleştirin.

    • GitHub deposu oluşturmayı (örneğin, Sphinx araçlarıyla) ve temel belge dosyalarını içerir
    • Bu ayrıca çeşitli bölümler / bilgi akışları için hem yeni kullanıcıları hem de eski kullanımları göz önünde bulunduran yeni bir İTŞ oluşturma sürecini de içeriyor.

  • Barebones iskelet TOC'sini inceleyin / onay alın

    GenPipes'in GSoD değerlendirme aşamasında, RTD'de barındırılan bu örnekle GenPip'ler için değer oluşturmaya çalıştım. Bunun yalnızca demo amaçlı olduğunu ve korumalı bağlantı olduğunu, henüz RTD'de herkese açık olarak listelenmediğini unutmayın. Kısa listeye alınma durumundan bağımsız olarak bu demo, GenPipes'in RTD çalışmalarını hızlı bir şekilde başlatmak için kullanılabilir. c3g/GenPipes GitHub deposundaki kaynakları daha önce kontrol ettim. Mentorlar Rola ve Hector, daha önce Skype "ekranı paylaşma" tartışmasında bu özelliği sevdiler. Ben de GSoD Gods'ın da görmek isteyebileceğini düşündüm. İskelet çatlakları için şimdilik. 30 Temmuz'a kadar vaktiniz olduğunda onu güncellemeyi planlıyorum.

https://genpipes.readthedocs.io/en/latest/

2. Adım: GenPipes Doc v0.9 doküman kümesi oluşturma

  • GSoD zaman çizelgelerini göz önünde bulundurarak RTD'de barındırmak için hangi mevcut veya mevcut GenPipes dokümanlarının içe aktarılabileceğini, bağlanabileceğini veya Sphinx/rst tabanlı dokümanlara dönüştürülebileceğini belirleyin.

  • Tanımlanmış dokümanları rst biçimine dönüştürün, gerekirse yenilerini oluşturun, mümkün olan / ilgili dokümanları yeniden kullanın.

    • Kavram Kanıtı olarak ReadTheDokümanlar'a ayarlanmış bu ilk dokümanı içe aktarın ve burada korumalı bir depo olarak barındırın. İncelemeye/resmi geçiş yapılana kadar yeni kullanıcıların GenPipes'in orijinal dokümanlarına gitmesini öneren bir not ekleyin.

  • İncele/kurs-düzeltme/güncelleme

3. Adım: İlk taslağı RTD'de hassaslaştırın, inceleyin ve yayınlayın

  • Önerilen GenPipes yeni doküman yapısının ayrıntılarını GenPipes TOC'sine girin: İlk birkaç belgenin yanı sıra daha fazla doküman (GenPipes Readme), Concepts, Tutorials vb. ekleyin.

  • Yeni kullanıcılara, deneyimli GenPipes kullanıcılarına, GenPipes geliştiricilerine vb. hitap etmek için TOC'de net bir özgürlük belirtin.

  • GenPipes dokümanlarının nasıl sağlanabileceği, düzenlenebileceği ve C3G'nin harici kuruluşlara katkıda bulunan kullanıcılara izin verip vermeyeceğini belirlemek için RTD (sfenks derlemeleri) aracılığıyla kısmi otomasyon içeren bir çalışma sürecini tartışın. Bu, doküman güncellemeleri için kodlama yönergelerine benzer bazı yönergeler oluşturulmasını gerektirebilir. Daha fazla alt adım gerekebilir. Örneğin, GenPipes dokümanlarında PR onayından önce yazım denetimini otomatik hale getirin.

Bildir

Son olarak, GSoD için deneyimlere, günlüklere ve mentorlardan gelen geri bildirimlere dayalı bir rapor oluşturun.

Diğer düşünceler

Gelecekte (3 aydan daha uzun bir süre) için geçerli olduğu durumlarda, GenPipes'in bu hizmeti daha uzun vadede sürdürmesine yardımcı olabilirim. Veya gerekiyorsa başkalarını da bu eğitim için eğitin. Bunu ilk 3 ayın sonucuna göre belirleyebiliriz.

Ayrıca, işe alım sürecini kolaylaştıracak bir GenPipes 3 sayfa özeti oluşturmak gibi ek bir proje teklifi fikrini de öneririm. Günümüzde yeni bir kullanıcının GenPipes'i kullanmaya başlamadan önce bir sürü adım atması gerekiyor. Dokümanlar iyi ancak dağınık ve yeni kullanıcılar için elverişli değil. Bunu 3 ay içinde yapıp yapamayacağınızdan emin değilim ama denemek ve denemek isterim.

Aynı teklif ve nasıl ortaya çıktığı (geçmiş) https://drive.google.com/file/d/1oKVp_7ZeYGMxhynfc97qUUcGNh2CNbX0/view?usp=sharing adresinde de görülebilir.