TL;DR

• backlog はかなり緑だけど、よく出来てた
• gollum は backlog と比べると、今の組織ではまだ早い
• 気合があれば gollum を修正して使うといいんじゃないの

背景

1

【緩募】シンプルな wiki で無料で markdown がかけてデザインがイケてて添付ファイルが up できて backlog より便利なヤツ  

こういう要求があった。
今、会社で wikiシステムにも backlog を使っていて、よく出来ているんだけど、
エンジニア的な視点からは非常に使いづらい気がしていて、
markdown でもっとイイ感じのなにかが欲しかった。

はたして backlog の何が不満なのか

• なんか全体的に緑なデザイン
• markdown プレビューがだるい点
• (重要)コンフルに比べて、小ページの概念がないこと
  
  • いま気づいたけど、これがマジでイケてない。コンフルはそれが便利だったことに今気づいた。
    
    • どうでもいいけど コンフルは検索がクソな印象がある。
• (重要)なんかロックインされちゃう点
  

  • ぶっちゃけ疎にしておきたい。(エクスポート

    インポートできるようになっていてほしい(調べてない))

  • markdown という表記自体もある種ロックインだけど、markdown からの変換は期待できるし、現在のデファクトだからそれはそれでいいかと..

それで気になっていた gollum を評価した

gollum はシンプルな wiki で、かなり良く出来ていると思う。
ただ、まだ実用にはたえないと思う。足りないと感じている点は以下に述べる。

足りないと感じている点

• pdf のファイルを添付したとき、それがプレビューにならない(pdf.js的な)。
• ファイルを添付した場合、その画面に添付されているリストが出て欲しいが、出ない
• ライブプレビュー機能はあるがずいぶん画面が変わってしまう。非エンジニアにとっては、ライブプレビューがない方が使いやすい(WYSWIG?だっけ、があるから)
• だけど、ほんとはライブプレビューしたい。 docbase みたいなライブプレビューがある方が良い。
• どのファイルが最近編集されたのか、というようなストリームが欲しいが、ない。
• 多くのボタンが英語で書かれている点。
  
  • rails 的に i18n でおけばイイってことではないように見える。
• ディレクトリ一覧のファイルを見たいとき、URL を削ってディレクトリを指定するが、そのとき期待する動作は自分にとってはそのパス以下のファイル一覧であるが、見れない(ページ作成になる)。
  
  • Apache とかでディレクトリの中が見えてるあれを期待してる(伝われ)
• あるファイルを見ている時、それ以下のファイルが木構造で見えていて欲しい、もしくは簡単に見えるようになってほしい
  
  • コンフル小ページの発想
• Dropbox と連携とかするとウマイことできるかなぁと感じたけど、エクセルとかそういうのを web で見ようとしてダウンロードになっちゃって辛みみたいなのがかなりある
• (自分はあまり必要としていないが)変更をメールで飛ばせる機能がない
  
  • そういう意味で コンフルも一度編集したら勝手に記憶していて、メール通知が飛んでくる機能があった。まぁ悪くない。
• 日本語での検索でエラーがでる(これはたぶんいろいろ追ったら普通に修正可能だと思う)
• チームで使うなら、TOP のロゴみたいなやつは欲しい。

ただ、これらのほぼすべてについて、自分たち用に修正することができるのは、とんでもないメリットだ。
ただ修正するには時間が必要であることは間違いない。

良いなと思っている点

• シンプルで動作が早く、unix な人にはかなり便利に使える点
• ディレクトリを スラッシュで切っていく点は本当に便利(アトラシアンのコンフルとかで／とかで区切っていた風潮)
• markdown でかける
• h1, h2 がリンクになる点。これは素晴らしい。
• (重要)すべてがファイルになっているので、なにかいい仕組みが出てきた時に気軽に変更できる点

gollum 使用方法 memo

https://github.com/gollum/gollum を見て欲しい。
日本語対応はこの記事 を参考にした。
なんか、普通に保存したときエラーがでるのは、 ググッた結果 Gemfile に
gem 'gollum-rugged_adapter' を追加してなんかウマイことやったら回避できた。

1
2

# アップロード付き、 rugged はエラー回避で必要だった、 show-all でファイルが全部観れる
bundle exec gollum --allow-upload page --adapter rugged --show-all

所感

こと、営業職の多い組織だと、素での gollum 使用はしんどいに違いない。
backlog と比べて出来ないことが多すぎて、それ以上のメリットを享受できないからだ。
だから、大抵の場合はたぶん既存で使っているやつのほうがいいかもしれない。

エンジニアが多い職場で、本当に金がないなら、これは導入する価値はあると思う。
(ぶっちゃけ、markdown 系共有のサービスで有料なものが多すぎると思う。
エンジニアとしてビジネスする側で考えたら非常にいいなと思うけど、
おかね払って使う立場から考えたら markdown が共有できたくらいでお金を払いたくないっていうのが
僕の正直なキモチだ。)
(そして逆に言うと、このオープンソースを使って自分が欲しい機能を付け足すだけで
お金をとれるレベルのサービスを創れる気もする。fork して月額100円くらいで売り出したい。
(まぁそんな時間ないんだけども。) ) でも、今考えると gollum と、 qiita や docbase とかって微妙に立ち位置が違う気もしてきた。

https://support-project.org/knowledge_info/index っていうオープンソースを作っている人がいて、これもかなり有用で、いい感じな気はしているんだけど、
個人的に、Java で書かれているのがネックで、JVM を起動したり、Java でメンテするってのを考えると
ちょっと敷居が高かったりするのがホンネだ。

そういう意味で、何もなかったら gollum に contribute したいんだけど、
ぶっちゃけそれ以上にやらなきゃならんことがたくさんあるのでちょっとしんどい。
それでも少しずつは貢献できたらいいなと思う(したいに価値はないが)。

この週末というか今日はかなりコレの評価に費やしたので記事にしておく。
だれかにとってこの記事がためになれば幸いです。