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:
- Tor Projesi
- Teknik yazar:
- Kocaeli
- Projenin adı:
- Tor manuel sayfasını yeniden yazın
- Proje süresi:
- Uzun süreli (5 ay)
Proje açıklaması
Bu projeden ne beklediklerini anlamak için TOR mentorlarıyla görüştükten sonra, işbu belge (https://2019.www.torproject.org/docs/tor-manual.html.en) için tutarlı bir yapı ve biçim oluşturmak amacıyla aşağıdaki fikirleri öneriyorum. Böylece, kullanıcılar için yararlı ve hızlı bir başvuru kaynağı haline getirebileceklerini söyleyebilirim. Bu proje 3 ay içinde tamamlanacak ve aşağıdaki fikirler aya göre gruplandırılmış.
1. Ay:
Bu sayfa için bir içindekiler tablosu oluşturun. Kullanım Şartları'nda, genel bakış konusu ve 9 yapılandırma seçeneği kategorisinin başlıkları yer alacaktır. Bu ayın sonunda kullanıcılar parmaklarının ucunda farklı yapılandırma kategorilerine gidebilecek. İçindekiler aşağıdaki gibi görünür:
- Genel Bakış – TOR'nun bu farklı seçenek kategorileri için yapılandırmayı nerede koruduğu, hepsinin aynı yerde olup olmadığı, yapılandırma dosyasının adı ve varsayılan konumu, komut seçeneklerini kullanma kuralları ve kullanıcıların bu seçenekleri nasıl değiştirebileceği hakkında bilgi ekleyin. (Giriş metnindeki bilgileri YAPILANDIRMA DOSYA BİÇİMİ konusu altına ekleyebiliriz).
- Genel Seçenekler
- İstemci Seçenekleri
- Sunucu Seçenekleri
- Dizin Sunucusu Seçenekleri
- Ağ Seçeneklerini Test Etme
- Hizmet Reddi Çözüm Seçenekleri
- Dizin Yetkisi Sunucusu Seçenekleri
- Gizli Hizmet Seçenekleri
- Kalıcı Olmayan Seçenekler
2. Ay:
Manuel sayfanın amacı, her seçeneğin ne işe yaradığı ve ne yaptığıyla ilgili soruları hızlı bir şekilde yanıtlamak olmalıdır. Şu anda seçenekler yapılandırılmış bir biçimde belgelenmemekte ve her seçenekle ilgili bilgiler, bilgilerin bir bakışta bulunmasını zorlaştıran paragraflar halinde sunulmaktadır. Seçeneklerle ilgili mevcut tüm bilgilerin bir şablon kullanılarak yeniden düzenlenmesi gerekir. Bu ayın sonuna kadar, mevcut seçenekleri ve gelecekteki tüm yeni seçenekleri belgelemek için tutarlı bir biçimimiz olacaktır. Bu biçim ayrıca TOR kılavuzunun gelecekte "erkek" sayfaları olarak kullanılmasını kolaylaştıracaktır.
- İlk olarak, her bir seçenek kategorisi hakkında (Sunucu Seçenekleri, İstemci Seçenekleri vb.) kısa bir açıklama ekleyin. Açıklamalar, kullanıcıların her bir kategoride hangi seçenekleri beklemeleri gerektiğini anlamalarına yardımcı olacaktır.
- Her seçeneği belgelemede tutarlı bir biçim tanımlamak için bir şablon oluşturun. Aşağıdaki bölümlerin/alt bölümlerin şablona dahil edilmesini öneriyorum.
- Ad: Belgelenen seçeneğin adı. Örnek: BandwidthBurst
- Özet: Seçeneğin komut satırı söz diziminin özeti. Örnek: BandwidthBurst N bayt
- Açıklama: Yapılandırma seçeneğinin ne işe yaradığını ve varsayılan değerin ne olduğunu açıklayın. Örnek: Busrt olarak da bilinen maksimum jeton paketi boyutunu her yönde verilen bayt sayısıyla sınırlamak için bu seçeneği kullanın. Bu seçenek varsayılan olarak 1 Gbayt'tır.
- Seçenek değeri: Seçeneğin izin verdiği değerleri listeleyin ve açıklayın. Her bir değerin ne yaptığını ve kullanıcının değerleri nasıl girmesi gerektiğini ayrıntılı olarak açıklayın.
3. Ay:
Şu anda 9 yapılandırma seçeneği grubu/kategorisi bulunmaktadır. Aranabilirliği artırmak ve hızlı başvuru yapmak için 9 kategori içinde alfabetik olarak sıralanmış yapılandırma seçeneklerinin listelendiği bir dizin sayfası oluşturun. Ardından bu kategoriler kullanım önceliklerine göre sıralanabilir. En sık kullanılan seçenek kategorileri en üstte yer alır.
3 ayın sonunda, kullanıcıların TOR'daki yapılandırma ayarlarını değiştirmek için hızlı bir başvuru olarak kullanabileceği yenilenmiş bir Kullanım Şartları Kılavuzu hazırlayabiliriz.