Docmost - Confluence ve Notion’a benzer açık kaynak iş birliğine dayalı dokümantasyon ve wiki yazılımı

 (github.com/docmost)
4 puan yazan GN⁺ 2024-06-30 | 3 yorum | WhatsApp'ta paylaş
  • Docmost, ekiplerin belgeleri birlikte yazıp yönetmesi için geliştirilmiş açık kaynak iş birliğine dayalı wiki ve dokümantasyon yazılımıdır
  • Başlıca özellikleri arasında gerçek zamanlı iş birliği, Spaces, izin yönetimi, gruplar, yorumlar, sayfa geçmişi, arama ve dosya ekleri yer alır
  • Dokümantasyonda Draw.io, Excalidraw ve Mermaid tabanlı diyagramlar, Airtable·Loom·Miro gibi embed’ler ve 10’dan fazla dil için çeviri özelliği bulunur
  • Başlamak için resmi dokümantasyona bakabilir veya bulut sürümünü deneyebilirsiniz
  • Docmost core, AGPL 3.0 ile lisanslanır; Enterprise özellikleri ve belirtilen dizinlerdeki dosyalar Docmost Enterprise lisansına tabidir

Docmost’a genel bakış

İş birliği ve dokümantasyon özellikleri

  • Real-time collaboration desteği sunar
  • Belgeleri alanlara ayıran Spaces özelliği vardır
  • İzin yönetimi ve grup özellikleri sağlar
  • Yorumları ve sayfa geçmişini destekler
  • Arama ve dosya eki özellikleri dahildir

Diyagramlar, embed’ler, çeviri

  • Diagrams özelliği Draw.io, Excalidraw ve Mermaid’i destekler
  • Embeds Airtable, Loom, Miro ve benzerlerini kapsar
  • Çeviri, 10’dan fazla dili destekler

Lisans yapısı

  • Docmost core, açık kaynak AGPL 3.0 lisansı ile sunulur
  • Enterprise özellikleri, Enterprise Edition’ın kurumsal lisansı kapsamında sağlanır
  • Aşağıdaki dizinlerdeki tüm dosyalar packages/ee/License içinde tanımlanan Docmost Enterprise license kapsamındadır
    • apps/server/src/ee
    • apps/client/src/ee
    • packages/ee

Geliştirme ve teşekkürler

  • Katkıda bulunmak isteyenler development documentation sayfasına bakabilir
  • Crowdin, yerelleştirme platformuna erişim sağlar
  • Algolia, dokümantasyon için tam metin araması sağlar

İlgili okumalar

3 yorum

 
nutella 2025-01-10

Şirkette Notion da olmuyor, Obsidian da engellenmiş... Denemek için kullanmayı düşünüyorum; iyi bir alternatif gibi görünüyor.
 
moderato 2024-10-10

Deneyince Notion’a benzer şekilde iyi yapılmış bir araç gibi geldi.
Ama Notion’a fazla benzediği için, Notion’dan farklı olduğu noktalarda rahatsızlık yaratan durumlar da oluyordu.
Umarım iyi şekilde gelişir.
 
GN⁺ 2024-06-30
Hacker News görüşleri

  • Notion ve Confluence’ın erişilebilirliği ikisi için de gerçekten berbat
    Docmost’u geliştirirken bu konuyu dikkate alıp almadığınızı merak ediyorum. ABD’deki ADA ve yakında yürürlüğe girecek AB’deki EAA düşünüldüğünde, kurumsal benimseme için oldukça önemli bir unsur; bu kez erişilebilirlik ödevini düzgün yapmış bir ürün olsa iyi olur. İsterseniz bir kez inceleyebilirim. Not olarak: yerel ekran okuyucu kullanıcısı, görme engelli, geliştirici ve erişilebilirlik denetçisiyim

    • Sıradan ellere ve gözlere sahip kişiler için bile böyleyse, engelli kişiler için nasıl olacağını hayal edin
    • Erişilebilirliği düşündüm
      Örneğin kenar çubuğundaki sayfa ağacı klavye ile gezinmeyi destekliyor. Kullandığımız UI kütüphanesi Mantine de erişilebilirlik en iyi uygulamalarını izliyor ve tam klavye desteği sağlıyor. Hâlâ yapılacak çok iş var ama proje ilerledikçe destek daha da artacak. Daha önce Twitter başlıklarını sesli dinlemeyi sağlayan Twitter botu @threadvoice’u yapmıştım; o zaman da erişilebilirlik motivasyonlardan biriydi
      https://twitter.com/Philipofficial9/status/11899711858004869...
    • Kimlik doğrulama da sorun. Bu iki sitede yeniden giriş sürecinden geçmektense her şeyi kaybetmeyi tercih ederim diye düşünüyorum
    • Şirketler erişilebilirliği zaten bu kadar kötü olan Confluence ve Notion’ı kullanıyorsa, bunun şirketler için pratikte ne kadar önemli olduğu şüpheli
    • Önemli elbette ama projeye yeni başlarken ilk çözülecek kalem olarak koymazdım

  • Küçük bir geri bildirim olarak, ürünü denemek istedim; web sitesi de temiz ve umut verici görünüyordu ama kurulum sayfası gözümü korkuttu ve neredeyse vazgeçiyordum
    İlk talimat Docker kurulumuydu; bölüm adının “Prerequisites” olduğunu biliyorum ama kurulum yöntemi yalnızca Docker ise docker-compose ve değişken dokümantasyonu gibi bir şey beklerdim. “Installation Steps” de mkdir, cd, curl, vi ile başlayıp sonunda “bu docker-compose’u kullanın” akışına varıyor. Önkoşullar pek çok kişi için önemli olabilir; bunu sorun olarak görüyorsanız çözmenin çeşitli yolları var. Geliştiriciler ve teknolojiye aşina kişiler her şeyi atlayıp terminal komutlarına ya da koda bakar. Bu yüzden depo README’sinin üst kısmına “yapmayın” denecek şeyleri çok yukarı koymamak gerekir; çünkü ilk kopyalayıp yapıştıracağımız kısım orası olur. Eleştiri değil, harika yapmışsınız gibi duruyor; sadece o sayfada kaybedebileceğiniz sıradan bir denemecinin geri bildirimi
    https://docmost.com/docs/installation

    • Docker kurulum talimatlarını çıkarmak daha iyi olur. İnsanlar bunu Docker dokümanlarında görebilir; başka bir yerde tekrar etmenin pek nedeni yok
      Ayrıca ortam değişkeni yönetimi için docker compose dosyasını düzenletmek yerine .env dosyası kullanmak daha iyi olur. Pek çok kişi yaml dosyasını sürüm kontrolüne alma eğiliminde olacağından, gizli değerleri orada düz metin olarak tutmak iyi bir fikir değil
      https://docs.docker.com/compose/environment-variables/set-en...
    • Benimsemeyi artırmak istiyorsanız hepsi bir arada container sunmanız gerektiğini düşünüyorum
      runit kullanıp veritabanını, redis’i ve uygulamayı aynı container’a koyun; yanına da büyükçe tek bir veri dizini ekleyin. Container çalıştırabilen çoğu küçük ekip için bu yeterli olur ve “bir deneyelim” deneyimi sadece docker run hâline gelir

  • Hâlâ VPN arkasında Confluence on-premises kullanıyoruz. Taşınmak için PDF dışa aktarma, Gliffy gibi entegre diyagram editörü, geçmiş ve diff gerekiyor
    Şimdiye kadar Outline en yakınıydı ama acil değil; bu projenin gelişimini de izleyeceğim

    • XWiki SAS, Confluence’tan XWiki’ye geçiş için bir araç geliştiriyor
      XWiki, Confluence ile benzer dönemde başlamış açık kaynaklı bir wiki yazılımı ve bahsettiğiniz özelliklerin hepsine sahip. Migrasyon desteği ve danışmanlık da sunuyor; geçiş aracı içerik ve işlevleri mümkün olduğunca korumaya çalışıyor, uyumlu makrolar üzerinde de çalışılıyor. Gerekirse iletişime geçebilirsiniz
      https://xwiki.com
      http://xwiki.org
    • Confluence tarafından gelince kaçırılması kolay en büyük ihtiyaç bence wiki ile kod dokümantasyonunun entegrasyonu
      Kodun README’leri ile sphinx, mkdocs, swagger gibi kod tabanından üretilen dokümantasyonu wiki ile birlikte bağlamak önemli. Entegre diyagram editörü konusunda Mermaid veya Kroki gibi doküman-olarak-kod soyutlamalarında standartlaşılırsa, diff alınabilen diyagram kodundan ve çeşitli açık kaynak editörlerden yararlanılabilir. VSCode eklentilerinde de birkaç uygulama var; Mermaid’i seçerseniz aynı diyagramın wiki araçlarında, GitHub’da ve Foam, Dendron, Obsidian.md gibi yerel-öncelikli açık içerik biçimi araçlarında birlikte çalışması güzel olur
    • Bu amaçla Bookstack kullanıyorum ve tavsiye edebilirim. Ücretsiz ve açık kaynak
      PDF dışa aktarma, OAuth2, revizyonlar, geçmiş, yetkiler, WYSIWYG/Markdown/diyagram vb. destekliyor
      https://www.bookstackapp.com/
    • PDF dışa aktarma gelecek
      Diyagramlar da gelecek; sıradaki MermaidJs. Draw.io ve Excalidraw gibi diğer diyagram sağlayıcıları, ham veriyi verimli şekilde saklama ve geri getirme yöntemini netleştirdikten sonra eklenebilir. Sayfa geçmişi destekleniyor ama henüz diff yok
    • Confluence’ta kullanmadım ama https://www.tldraw.com/ en azından Notion’a gömülebiliyor ve diyagram editörü olarak çok iyi çalışıyor

  • Şirkette dokümantasyon araçlarını değerlendiriyoruz; regülasyon ortamımız biraz kendine özgü olduğu için belgeyi oluşturan kişiyle inceleyip onaylayan kişi farklı
    Bu yüzden belgeler için merge request kavramı ayırt edici bir özellik olabilir. Birinin belgeyi oluşturup, başka birinin düzenlemesi ve ardından değişiklikleri inceleme isteği olarak göndermesi gibi. GitBook’ta var, ama diğer temel kısımlar bizim için eksik

    • Bunu uzun zamandır istiyordum ama düşününce, yalnızca Git kullanıp Markdown belgelerini bir Notes System’a push etmeyi daha çok tercih eder hale geldim
      Düzenleme, inceleme ve birleştirmeyi başka bir sistemin yapmasını istemiyorum. Belgeleri Git’ten gönderip, belgeyle ilgili gerekli özellikleri düzgün barındıran bir sisteme sürekli dağıtım yapmak istiyorum
    • Harika bir özellik olabilir. Benzer bir sorunumuz var: inceleme sürecinden geçmiş resmi bir belge sürümü var ve bir sonraki sürüm üzerinde Confluence’ta çalışmak için ayrı bir çalışma sayfası oluşturmak gerekiyor
      Bu da arama sonuçlarını kirletiyor ve kısa sürede ortalığı dağınık hale getiriyor
    • Belge merge request’i temel gereksinimse, Git’in ya da başka bir sürüm kontrol sisteminin karşılayamadığı başka hangi özelliklerin gerektiğini merak ediyorum
    • Olsa gerçekten çok iyi olurdu

  • Wiki’leri ve şirket içinde wiki kullanmanın belirli biçimlerini çok seviyorum
    Ancak wiki’yi anlamayan müşterilere kurumsal satış yapmaya kapılmış gibi görünen bazı wiki yazılım ürünlerini o kadar sevmiyorum. Bazı kurumsal ürünlerin oldukça iyi yaptığı şeylerden biri çizim aracı entegrasyonuydu. Şirketteki herkesin bu entegrasyona ihtiyacı yok, ama bazı kullanıcılar için gerekli; bu sayede, aksi halde kayda geçmeyecek çok yararlı görsel materyaller belgelenebiliyor

    • https://www.tldraw.com/ en azından Notion’a canlı olarak gömülebiliyor; böylece aslında bu özelliği desteklemeyen bir wiki içinde bile oldukça iyi bir ortak çizim deneyimi sağlıyor. Confluence’ta veya başka araçlarda henüz denemedim
    • Wiki’leri neden sevdiğinize dair temel bilgeliği birkaç maddeyle özetleyebilir misiniz, merak ediyorum. Özellikle şirket içinde hangi kullanım biçimlerinin en etkili olduğunu bilmek isterim

  • Çoğu dokümantasyon yazılımındaki en büyük sorun iki tane
    Birincisi, her şeyin içeride kilitli kalması. Notları kolayca dışa aktarabilmek veya yedekleyebilmek gerekir. İkincisi, fiyatlandırma politikası çok fazla küçük küçük para koparıyormuş gibi hissettiriyor. Belge ağacında 100’den fazla node olunca plan yükseltmen istenmesi ya da projeye her kişi eklediğinde bunun bir satın alma kararına dönüşmesi yorucu. Postgres ve Redis’i nasıl kullandığınızı biraz daha anlatabilirseniz iyi olur

    • Postgres, tüm workspace ve kullanıcıyla ilgili verileri saklayan ana veritabanı
      Redis ise kuyruklar, sunucular arası ortak düzenleyici durum senkronizasyonu ve sunucular arası WebSocket senkronizasyonu için kullanılıyor. Son iki özellik, yazılımı birden fazla node veya replika ile çalıştırırken önemli

  • XWiki’de çalışıyorum. Açık kaynak alternatifler geliştiren meslektaşları görmek sevindirici; bu tür girişimler ne kadar çok olursa o kadar iyi
    Confluence ile boy ölçüşecek bir şey yapmak gerçekten çok iş gerektiriyor ve XWiki bu alanda en başından beri var. Docmost’u XWiki ile karşılaştırınca nasıl konumlandırdığınızı ve neden güçlerinizi birleştirmemeyi tercih ettiğinizi merak ediyorum
    https://xwiki.org

    • Confluence’tan açık kaynak bir şeye geçmek istediğim için XWiki’yi denedim, ancak kullanıcı deneyimi görece pürüzlü geldi
      Confluence benzeri bir deneyim isteyenler için bunu daha kabul edilebilir kılacak önerilen bir eklenti paketi var mı, merak ediyorum

  • Şu özellikler olsa güzel olurdu
    İstediğim editörü kullanarak sayfaları Git’te veya başka bir sürüm kontrol sisteminde düz metin olarak yönetebilmek ve tarayıcıya girmeden sayfaları commit edebilmek isterdim. Sayfalar herhangi bir işaretleme diliyle yazılabilsin; ancak Markdown bazı alanlarda ifade gücü açısından yetersiz olduğu için basit sayfaların dosya uzantısından Markdown olduğu anlaşılabilsin, wiki ise reStructuredText gibi kullanıcı tarafından genişletilebilir daha güçlü biçimlere de izin versin. Ayrıca sayfaların sunucu tarafında render edilip kolayca cache’lenebilmesi iyi olurdu. Sayfalar dosyaysa sha toplamıyla cache geçerliliği kolayca kontrol edilebilir; böylece yavaş ve berbat Confluence’ın aksine neredeyse anında gösterilebilir

    • Tam olarak aynı kullanım senaryosu değil ama bir projenin statik dokümantasyon sitesini oluşturmak için https://nextra.site/’i çok iyi şekilde kullanıyoruz
      Çoğunlukla sadece normal Markdown yazdırırken, gerektiğinde React component’lerine inebilme dengesini iyi kurmuş. main’e merge edince GitHub Pages’a sürekli dağıtım yapmak oldukça iyi bir deneyim
    • Markdown belgelerini tarayıcı dışında yazıp Git ile sürüm kontrolü yapacaksanız böyle bir araca neden ihtiyaç olduğunu anlamıyorum. Bu, amacın kendisini boşa çıkarmıyor mu diye düşünüyorum
      Yoksa geliştirici dostu bir workflow ile belgeleri yükleyip, geliştirici olmayan ekip üyelerinin görmesini mi amaçlıyorsunuz, merak ediyorum. Genel olarak gerçekten kötü bir fikir olduğunu düşünüyorum. Kendi barındırdığınız, muhtemelen bol hatalı bir MVP’yi ekibin önüne koyup, kendiniz herkesin kullandığı UI katmanıyla uğraşmıyorsanız, bu tepki ve araç değişimi doğuracak bir kombinasyon. Teknik kurucuların bu hatayı çok yaptığını gördüm. Statik site + Markdown + Git’in geliştirici olmayanlara ölçeklenmediğini fark ettikleri ve kendilerinin kullanmadığı headless CMS’in günlük kullanımda berbat olduğunu anladıkları pazarlama sitesi CMS’lerinde de aynı şey yaşanıyor
    • Şirkette bu amaçla Jekyll kullanıyoruz; GitHub Actions ile siteyi build edip GitHub Pages’ta barındırıyoruz
      Çok iyi çalışıyor ve Mermaid diyagramlarını, MathML’i vb. de destekliyor
    • MyST’yi gördünüz mü merak ediyorum. ReST kadar ifade gücü yüksek ve kişisel olarak çok daha kolay yazıldığını düşünüyorum
    • Markdown karşıtlığına bir oy da benden
      Markdown basit belgeler için fena değil, ama sayfalar arası bağlantıların merkezi olduğu wiki’ler için çok zayıf. Kişisel olarak Creole işaretlemenin wiki yazımı için çok daha iyi olduğunu düşünüyorum. Dosya biçimini uzantıda saklamak yerine, metadata’yı gerçekten metadata olarak saklamak daha iyi. Uygulamanın zaten çok daha fazla metadata tutmak istemesi olası, bu yüzden sonunda bir metadata depolama düzenine ihtiyaç doğacak. Metadata’yı dosya adlarından çıkarma konusunda yalnız bir haçlı seferine çıkmış durumdayım

  • Confluence, şimdiye kadar kullandığım kurumsal yazılımlar arasında, belki de devasa Jira hariç, en yavaş olanıydı
    PayPal’da “Confluence’ı bekliyorum” ifadesi, “monorepo’m tüm bağımlılıkları indiriyor” gibi bir deyime dönüşmüştü. Mahallenin öbür ucundaki bir belgenin yüklenmesini beklerken karşıya geçip kahve içip gelebileceğiniz kadar uzun molalar mümkündü. O belgeyi güncellemeyi denememiştim bile; bu yüzden bundan daha iyi olan her şey daha iyidir. Neredeyse abartı değil

  • Çok harika bir proje. Desteklemenin bir yolu var mı merak ediyorum
    Belgelerin Docusaurus kullandığını da gördüm; burada Docmost’un kendisini kullanmak da iyi olabilir. Böylece salt okunur olsa bile bir demo ortamı olur ve aynı zamanda kendi ürününü kullanarak geliştirme yaklaşımı da sağlanmış olur