Munin の文章

提供: Munin.jp wiki
移動: 案内検索


この文章は、いわゆるメタ(雛形)であり、 Munin 関連文章の書き方を説明します。


関連文章について

プラグインの文章
プラグインに関する文章は、プラグインが記述されたコードのファイルに含みます。ここでは POD 形式 [1] のフォーマットを用います。munindoc コマンドライン・ユーティリティを使用し、プラグインに関する情報を表示します。munindoc buddyinfo を呼び出すと、プラグイン buddyinfo に関するドキュメントを表示します。
記述方法は、Trac wiki に記載している [説明書]を読んでください。必要に応じて、コードファイルに含まれる pod セクションを追加・編集してください。プラグイン関連文章を改良するために、パッチや pull request を github で送って下さい。
Unin マニュアルページ
munin パッケージの一部に含まれます。ほとんどの Munin コマンド(munin-run や munindoc 自身)は 、Unin の man コマンドを用いて文章を読むことが出来ます。
Munin ガイド
今あなたが読んでいるこのページこそが、まさに Munin ガイドです。RST フォーマット[2]を使用します。もし、github アカウントがあれば、ページをオンラインで編集したり、プル・リクエストを送信することで、Munin マスタのリポジトリに貢献することができます。
Munin の Wiki
現時点では、上記の様々な文章が混在しています。Munin に関する文章は、将来的に wiki からこの文章に移行します。いずれ、この文章こそが、Munin ソフトウェアに関する文章であると言われるようになるでしょう。


[1] POD は Plain Old Document の省略語です(普通の古いドキュメントの意味)。Perl 言語の文章を記述するための、軽量マークアップ言語です。出典 wikipedia: http://en.wikipedia.org/wiki/Perldoc

[2] reStructuredText(よく rsST と省略されます)プロジェクトは、Python プログラミング言語における Doc-SIG (Documentation Special Interest Group = 文章に特化したグループの意) プロジェクトの一部です。出典 wikipedia: http://en.wikipedia.org/wiki/ReStructuredText


用語