Portal

Portal, herkese açık bir doküman ve blog sitesini çalışma alanının içinden yönetmeni sağlar. Dokümanları ve blog yazılarını Crewhall'da taslak olarak yazarsın, değişiklikleri gözden geçirir ve yayınlarsın. Ayrı çalışan bir Next.js sitesi yayınlanan içeriği okur ve ziyaretçilere arama, RSS akışı ve site haritasıyla sunar.

Portal'ı kimler kullanabilir​

Portal siteleri bir space'e değil, kuruma aittir. Siteleri ve site ayarlarını kurum yöneticileri yönetir. Yöneticiler üyelere portal içeriğini düzenleme, yayınlama ya da ikisi birden iznini de verebilir. Misafirler portalı düzenleyemez ve yayınlayamaz. Bu izinlerden hiçbiri sende yoksa Portal sol menüde görünmez.

Siteler​

Bir kurumun birden çok sitesi olabilir. Siteler arasında geçmek, Yeni site açmak ya da Docusaurus içe aktarmasına ulaşmak için Portal kenar çubuğunun üstündeki site seçiciyi kullan.

Site oluştururken site adını, bir Kısa ad (uygulama adreslerinde kullanılır, örneğin /portal/dokuman-sitesi), virgülle ayrılmış dilleri ve İlk versiyon'u gir. Ardından Siteyi oluştur'u seç.

Bir sitenin kenar çubuğunda şu ekranlar vardır: Genel bakış, Dokümanlar, Versiyonlar, Blog, Ana sayfa, Menü ve alt bilgi, Medya, SEO, Yayın geçmişi, İçe aktarma ve Ayarlar. Siteyi aç herkese açık siteyi açar.

Ayarlar​

Ayarlar site yöneticileri içindir ve dört bölümden oluşur:

• Site: site adı, alan adı, site başlığı, slogan ve herkese açık adres.
• Diller: dil ekle (örneğin de), kaldır ya da Varsayılan yap. Saat dilimi (zamanlanmış yayın) de buradadır.
• Next.js bağlantısı: sitenin okuduğu İçerik API adresi, Okuma anahtarı, Revalidate uç noktası (yayında çağrılır) ve Önizleme modu (taslak ve next). Bağlantıyı denemek için Test et'i kullan. Okuma anahtarı yalnız bir kez gösterilir; onu Kasa'ya ya da sitenin ortam değişkenine kaydet. Anahtarı yenile eski anahtarı hemen geçersiz kılar.
• Görseller: logo, koyu tema logosu, favicon ve varsayılan paylaşım görseli.

Next.js sitesini çalıştırmak sunucu kurulumunun parçasıdır. Bkz. Kendi sunucunda çalıştırma.

Genel bakış​

Genel bakış site durumunu gösterir: yayındaki URL'ler, yayınlanmamış değişiklikler, taslaklar ve her dilin çeviri durumu. Ayrıca Tümünü gözden geçir ile yayınlanmamış değişiklikleri, yayın durumunu (yeniden yayın webhook'u, site haritası, arama dizini), taslakları, eksik ya da güncel olmayan çevirileri ve son yayınları listeler.

Dokümanlar​

Dokümanlar solda Doküman ağacı'nı gösterir. Ağacın üstünden bir Versiyon ve Dil seç. Yeni ile Yeni doküman ya da Yeni kategori ekle. Yeni doküman, seçili versiyonda kaynak dilde taslak olarak oluşur.

Ağaçtaki her satırın menüsünde Yukarı taşı, Aşağı taşı ve Kategoriye taşı vardır. Çevirisi eksik dokümanlar işaretlenir, örneğin "en yok".

Dokümanın metninin üstünde şu alanlar bulunur:

Kategorinin Etiket, Açıklama ve Kategori sayfası alanları vardır: Otomatik dizin içindeki dokümanları listeler, Sayfa yok onu düz bir grup yapar. Bir kategoriyi silmeden önce içi boş olmalıdır.

Yayındaki bir dokümanı silmek onu Kaldırılacak olarak işaretler. Doküman bir sonraki yayında siteden kalkar; o zamana kadar geri yükleyebilirsin.

Doküman yazma​

Doküman editörü blok tabanlıdır. Blok eklemek için / yaz: başlıklar, listeler, yapılacaklar listesi, alıntı, sözdizimi renklendirmeli kod bloğu, tablo, sekmeler, açılır bloklar, yer imi, video, formül, Mermaid diyagramı, görsel, ayırıcı ve ham HTML.

Bilgi kutuları (admonition) / menüsünde Not, İpucu, Bilgi, Uyarı ve Tehlike olarak bulunur. Kutunun türünü Kutu türü ile değiştirebilirsin; Dikkat, Önemli, Başarılı ve İkincil de vardır. Kutuya isteğe bağlı bir başlık verebilirsin.

İçerik Markdown olarak saklanır. :::tip biçimindeki bilgi kutuları dahil Markdown yapıştırdığında editör onu bloklara çevirir. Dokümanın Diğer işlemler menüsündeki Markdown'ı kopyala dokümanı Markdown olarak kopyalar. Eklediğin görseller sitenin medya kütüphanesine yüklenir.

Değişiklikler kendiliğinden kaydedilir. Sen düzenlerken başka biri aynı dokümanı kaydederse Crewhall seni uyarır; değişikliklerini kopyala, sonra Yeniden yükle'yi seç.

Dokümanı sitede taslak içerikle görmek için üst çubuktaki Önizle'yi seç. Önizleme bağlantısı 1 saat geçerlidir.

Çeviriler​

Kaynak dil, sitenin varsayılan dilidir. Bir dokümanın seçili dilde çevirisi yoksa site o dilin adresinde kaynak metni gösterir. Çevirmek için dokümanı o dilde aç ve Çeviriyi başlat (kaynak metni kopyalar) ya da Boş başlat'ı seç. Çeviri, yayınlayana kadar taslaktır.

Dokümanın Diğer işlemler menüsündeki Çeviri görünümü, salt okunur kaynak metni çevirinin yanında gösterir. Kaynak dilin adını taşıyan kopyalama düğmesi (örneğin Türkçe kopyala) çevirinin içeriğini kaynak metinle değiştirir.

Kaynak metin, çevirinin son güncellenmesinden sonra değişirse çeviri Güncel değil olarak işaretlenir. Site o sırada çevirinin geride olabileceğini belirten bir not gösterir. Çeviriyi güncelledikten sonra Güncel olarak işaretle'yi seç.

Versiyonlar​

Dokümanlar versiyonludur. Versiyonlar ekranı onları listeler:

Yeni sürüm çıkarmak için Yeni versiyon dondur'u seç. Versiyon numarası'nı ve versiyon seçicide görünecek isteğe bağlı Etiket'i gir; gerekiyorsa Çevirileri de dondur'u seç. Dondurma, next'in o anki halini kopyalar ve geri alınamaz. Kopyalar bir sonraki yayında sitede görünür.

Bu ekrandaki diğer işlemler:

• Güncel versiyon yap: /docs o versiyona geçer, önceki güncel versiyon arşive iner.
• Versiyon seçicide görünsün: bir versiyonu sitedeki seçicide gösterir ya da gizler.
• next herkese açık: /docs/next adresini "Yayınlanmamış" şeridiyle yayınlar.
• Eski versiyon şeridi: arşivdeki versiyonların sayfaları güncel sürüme link verir.

Güncel versiyondaki bir dokümanı düzelttiğinde next'e de uygula değişikliği next'e de taşır.

Blog​

Blog yazıları durum, yazar, dil, tarih ve okuma süresiyle listeler. Yayında, Zamanlanmış ya da Taslak olarak süzebilirsin. Yeni bir yazı için Yeni yazı'yı seç.

Yazının bir başlığı, kapak görseli ve metni vardır. Okuma süresi kendiliğinden hesaplanır. Yazı ayarları altında şunları belirlersin:

• Slug ve Açıklama (SEO ve paylaşım).
• Yazarlar: kurumundaki kişiler ya da harici yazar adı.
• Etiketler: ziyaretçiler yazılara etikete göre göz atabilir.
• Yayın: Hemen (Yayınla'ya basınca) ya da sitenin saat diliminde tarih ve saatle Zamanla.

Yazının listelerde ve RSS'te ne kadarının görüneceğini seçmek için bir Özet sınırı bloğu ekle.

Medya​

Medya, sitenin medya kütüphanesidir. Dosyaları Yükle, Görsel, Belge ya da Kullanılmayan olarak süz ve her dil için alt metin gir. Her dosyanın kalıcı bir /media adresi vardır. Değiştir yeni dosyayı aynı adrese koyar, böylece linkler kırılmaz. Kullanıldığı yerler dosyanın nerede geçtiğini gösterir; kullanılan bir dosya silinemez.

Menü ve alt bilgi​

Menü ve alt bilgi sitenin üst menüsünü ve alt bilgisini düzenler. Etiketler dil başınadır, adresler ortaktır.

• Üst menü: sola ya da sağa öğe ekle. Öğe türleri Doküman kenar çubuğu, Blog, Link, Doküman, Dil seçici ve Versiyon seçici'dir. Her öğeyi gizleyip gösterebilirsin.
• Başlık ve logo: üst menüdeki site başlığı ve logo.
• Alt bilgi: link sütunları, telif satırı ({year} o yılın sayısına dönüşür) ve koyu ya da açık alt bilgi rengi.

Dahili linkler için + Doküman'ı kullan. Dokümanın slug'ı sonradan değişirse menü de onu izler.

Ana sayfa​

Ana sayfa sitenin giriş sayfasını dil başına düzenler. Yerleşim ve animasyon sitenin kodunda kalır; burada metin, görsel ve listeleri düzenlersin. Bölüm ekle'yi seç ve bir tür belirle: Üst bölüm, Hakkımızda, Video, Özellikler kartı, Teknolojiler, Topluluk, Açık kaynak projeler ya da Serbest metin. Bölümleri gizleyebilir, gösterebilir, sıralayabilir ya da kaldırabilirsin. Boş alanlarda kaynak dildeki metin gösterilir.

SEO​

SEO dört sekmeden oluşur:

• Sayfa ayarları: başlık, açıklama (70 ile 160 karakter arası önerilir), kanonik adres, paylaşım görseli, Arama motorlarında dizine ekle ve Sitemap'e dahil et. Önizlemeler Google arama sonucunu ve paylaşım kartını gösterir. Dil sürümleri hreflang ile kendiliğinden bağlanır.
• Site varsayılanları: {page} ve {site} alanlarıyla Başlık şablonu ve Varsayılan paylaşım görseli.
• Sitemap ve robots: robots.txt ve sitemap.xml her yayında yeniden üretilir.
• Yönlendirmeler: eski bir adresten yenisine yönlendirme ekle. Yayındaki bir doküman yeni bir adrese taşınınca yayın, Otomatik olarak işaretli bir yönlendirme ekler.

Docusaurus'tan içe aktarma​

Var olan bir Docusaurus sitesi içe aktarılabilir. İçe aktarmayı bir yönetici sunucuda komut satırından pnpm portal:import --from <docusaurus-repo> ile başlatır. İçe aktarma ekranı ardından raporu gösterir: aktarılan dokümanlar, yazılar ve kategoriler, medya, uyarılar, atlanan dosyalar ve eski siteyle eşleşen URL sayısı. Eksik adresler varsa SEO › Yönlendirmeler bölümünden yönlendirme ekle.

Yayınlama​

Sen yayınlayana kadar hiçbir şey herkese açık siteye çıkmaz. Her doküman, yazı ya da ayar bir durum gösterir: Taslak, Yayında, Değişiklik var, Kaldırılacak ya da Zamanlanmış. Üst çubuk kaç yayınlanmamış değişiklik olduğunu gösterir.

1. Üst çubukta Yayınla'yı seç.
2. Yayınlanacak değişiklikler'i gözden geçir. Her değişiklik türünü ve yeni mi, değişmiş mi, kaldırılıyor mu olduğunu gösterir. Bekletmek istediklerinin işaretini kaldır.
3. Yenilenecek URL'ler'e bak ve istersen bir Yayın notu ekle.
4. Yayınla'yı seç.

Sayfalar arka planda yeniden üretilir ve genelde birkaç saniyede yayına girer. Yalnız etkilenen URL'ler yenilenir. Zamanlanmış yazılar kendi saatlerinde yayına girer.

Yayın geçmişi​

Yayın geçmişi her yayını içeriği, kimin ne zaman yayınladığı, URL sayısı ve sonucuyla listeler: tamamlandı, Sürüyor, Başarısız ya da Kısmen yenilendi. Değişikliklerini ve URL'lerini görmek için bir yayını aç.

• Tek bir değişikliğin Geri al'ı ya da Bu yayının tamamını geri al, önceki sürümleri yeni bir yayın olarak yayınlar. Geçmişten hiçbir şey silinmez.
• Yeniden dene başarısız bir URL'yi tekrar yeniler. Başarısız URL'ler üç kez yeniden denenir; site o zamana kadar eski sayfayı sunar.
• İptal et zamanlanmış bir öğeyi durdurur.

Bir yayın başarısız olursa Portal bildirimi alırsın.

Sayfalar'dan Portal'a gönderme​

Sayfalar'daki bir sayfayı portal dokümanına çevirebilirsin. Sayfanın menüsünü aç ve Portal'a gönder'i seç. Site, Sürüm ve Dil'i seç, ardından Taslak olarak gönder'i seç. Aynı sayfayı aynı sürüm ve dile yeniden göndermek o taslağı günceller.

Sayfadaki görseller portal medyasına kopyalanır. İç bağlantılar düz metin olur; bahsetmeler ve gömülü öğeler aktarılmaz. Taslağı her zamanki gibi Portal'dan yayınla.

Herkese açık site​

Herkese açık site yalnız yayınlanmış içeriği gösterir.

• Adresler: dokümanlar varsayılan dilde /docs/<versiyon>/..., diğer dillerde /<dil>/docs/<versiyon>/... adresindedir. /docs güncel versiyonu açar.
• Dokümanlar: kenar çubuğu, sayfa yolu, "Bu sayfada" listesi, önceki ve sonraki linkleri, kod bloklarında kopyalama düğmesi, üst menüde versiyon ve dil seçici. Ziyaretçiler açık ve koyu tema arasında geçebilir.
• Arama: üst menüde arama kutusu ve ayrı bir arama sayfası.
• Blog: yazı listeleri, etiket sayfaları, yazar sayfaları ve arşiv.
• Akışlar: RSS /blog/rss.xml, Atom /blog/atom.xml adresinde; her yayında yeniden üretilir.
• Site haritası ve robots: /sitemap.xml ve /robots.txt.

Bir sayfa henüz çevrilmemişse, çeviri geride olabilecekse ya da ziyaretçi arşivlenmiş veya yayınlanmamış bir versiyonu okuyorsa site bunu bir notla belirtir.