はじめに

この記事はUEC Advent Calendar 2021の19日目(12/19)の記事です。

前日はごっちさんのおうちサーバーでサーバーレスです。1
VSCode拡張機能のおすすめになぜか出てくるKubernetesがなんなのかようやくわかりました。

さて、皆さんはWikiというものをご存知だと思います。知らない人のために、とあるクソデカWikiに書いてあったWikiについての説明を引用します。

ウィキ(Wiki)とは、不特定多数のユーザーが共同してウェブブラウザから直接コンテンツを編集するウェブサイトである。
Wikipedia

Wikiを説明するWikiって、なんか再帰っぽい感じがしますね。

Wikiは「みんなで情報を共有・蓄積するためのツール」として広く使われているわけですが、実際に自分で開設したくなったらどうやればできるのでしょうか?
ということで、この記事ではGROWIを使って部内Wikiを開設したという話をしていきたいと思います。

だれ

鈴木です。
この世界、この電通大、この20生には大勢の鈴木がいるのでSuzukeを名乗って差別化を図っています。

背景

私の所属しているバーチャルライブ研究会(VLL)とかいうサークルは起源が2017年の新興です。2019年に公認を得たりなどして異常なスピードで規模が拡大していますが、組織のインフラが追いついていない部分もそこそこあります(オブラート)。その改善の一環として本格的に部内Wikiについて検討し、7月ごろに導入に至りました。

調べて見つけたGROWIは導入に必要な作業のほとんど全てが私にとって未知だったので、めっちゃ基本的なことから調べまくってなんとかGCEインスタンスが再起不能になるところまで頑張りました。それ以上は無理だと思い、部内のつよつよな先輩になんとかしてもらって導入を完遂しました。

GROWIとは

GROWI

Markdown2で書けるWikiのソフトウェアで、Crowiのフォークのようです。WESEEK社によって開発されていますがGitHubに出ているOSSです。サーバー等を用意できれば無料で使うことができます。

サーバーらへんも用意してくれる有料プランもありますが、完全に企業向けです。学生はおとなしく自分で立てましょう。

選んだ理由

  • Markdownで書ける
  • 新しくてメンテされてそう
  • ドキュメントに立て方がほぼ全部書いてある
  • 見た目がかっこいい


(公式デモページ)

雑な作り方

基本的に、GCE環境でGrowiのドキュメントに則って作業すればできます。つまり、Googleアカウントさえあればできます。

  1. GCPでCompute EngineのVMインスタンスを起動
  2. GitHubからDocker Composeのファイルを持ってくる
    git clone https://github.com/weseek/growi-docker-compose.git growi
  3. docker-compose up でGROWIを起動
  4. http://localhost:3000/にアクセスしたら初期登録画面が出る!

(初期登録画面の例)

導入してどうだったか

ようやくVLLにドキュメントをまとめるところができました。 これだけでもすごい変化です。少しづつ記事が増えていますが、もっと速いペースで書いてもらわないと引き継ぎ終わらないよの気持ちで3年生を見ています。頑張って下さい。

Wikiを導入した一番の利点は、今まで関わっていなかった班(VLLではタスクを班で分けています)のドキュメントを探しやすくなったことだと思います。今までは各班がそれぞれ設置したGoogleドキュメントなどがありましたが、あとからその仕事に興味を持った人には到達しづらいという問題点がありました。これを解消していくことで、ますます複数の班に所属するのが容易になるでしょう。

たぶん。

まとめ

組織にWikiは導入すべきです。せっかく人が集まっているのですから、知識も経験も集めて貯めていきましょう。

ちなみに、一度データをほぼふっ飛ばす大事故をやらかしました。
バックアップはちゃんと取れ!!!!!!


明日はbokuroroさんの記事です。もう完成してるようなので安心して全裸待機できますね。

【更新】 20日目 数式処理ソフトのすすめ


  1. gottiの記事、ゴチ記事 ↩︎

  2. LaTeXやHTMLの仲間。めっちゃ簡単に書ける。GitHubのREADMEとかQiitaとかで採用されている。 ↩︎