Redmineにナレッジベース機能を追加するプラグインをインストールし、利用する方法

tetsu


Redmineにナレッジベース機能を追加するプラグインをインストールし、利用する方法

こんにちは、管理部兼エンジニアのtetsuです。

LIGではオープンソースのプロジェクト管理ソフトウェアの「Redmine」を利用しています。タスク管理、進捗管理、情報共有などにとても便利なソフトウェアです。

前回の記事「Redmineにプラグインをインストールし、CSVデータを取り込む機能を追加する方法」では、RedmineにCSVデータを取り込む機能を追加する方法を紹介しました。

今回はRedmineに、プラグイン「Redmine knowledgebase」をインストールし、ナレッジベース機能を追加する方法を紹介したいと思います。

Redmineを利用されている方の参考になれば幸いです。

プラグインのインストール手順

「Redmine knowledgebase」はRedmineに登録されている各プロジェクト毎にナレッジベース機能を追加するプラグインです。

  • GitHub

このプラグインではWikipediaのように、作成された記事に対してコメントをしたり、評価をおこなったり、カテゴリーで整理したりすることができます。

検証環境

以下の環境でプラグインをインストールする前提とさせていただきます。

  • Redmine 2.3.4
  • Ruby 1.9.3-p547

※今回のプラグインはデータベースに対しての処理をおこなうため、必ずバックアップをしておきましょう。

プラグインのダウンロード

Redmineが動作しているサーバへSSHで接続します。
SSH接続後、Redmineをインストールしているディレクトリにある「plugins」ディレクトリへ移動します。

cd {Redmineインストール先パス}/plugins

ディレクトリ移動後、次のコマンドを実行しプラグインをダウンロードします。

git clone git://github.com/alexbevi/redmine_knowledgebase.git

「plugins」ディレクトリに「redmine_knowledgebase」がダウンロードされればダウンロード完了です。

Redmineへプラグインを追加

続いてRedmineへプラグインを追加するために、次のコマンドを実行します。

cd {Redmineインストール先パス}/
bundle install
rake redmine:plugins:migrate NAME=redmine_knowledgebase

エラー無く処理が完了したらRedmineを再起動して、インストールが完了となります。

Redmine画面で「管理」の「プラグイン」に次のように表示されている事を確認します。
001

プラグインの利用開始前に

プラグインの利用開始前に、以下の設定をおこなう必要があります。

「Redmine knowledgebase」プラグイン初期設定

Redmineの設定「プラグイン」から、「Knowledgebase」に「設定」にて、プラグインの動作設定をおこないます。
基本的には初期設定のままで支障はありませんが、好みにあわせて動作設定をしてください。

プロジェクトへのモジュール追加

登録済みのプロジェクトでプラグインを利用する場合、該当プロジェクトのモジュールで「Knowledgebase」を選択する必要があります。

権限の付与

Redmineに登録している「ロール」に対してプラグインの権限「Knowledgebase」を付与する必要があります。
この権限を付与しなければ、プロジェクトでモジュール設定しても、利用ができません。

プラグインの利用方法

利用開始の準備が整ったところで、プロジェクトにアクセスするとメニューに「ナレッジベース」が表示されます。

アクセスすると次のような項目が表示される画面が表示されます。
002

はい、まだ何も無い状態での画面です…。
試しにカテゴリーと記事を登録した場合は、このような画面になります。
003

この画面ではカテゴリーに「サーバ情報」、記事に「FTP情報」で登録した結果です。

このように、必要なカテゴリーを登録して記事を投稿することで、ナレッジベースのTOPに表示されるようになります。あわせて、よく見られている記事や評価の高い記事などを把握することが可能となります。

まとめ

いかがでしたでしょうか。
ナレッジベースでは情報の共有が可能になりますし、途中参加した方や技術的な問題の解決方法などといった形で記録することもできます。

Redmineでナレッジベース機能を取り入れたい場合には、ぜひ参考にしてください!

tetsu
この記事を書いた人
tetsu

管理部

関連記事