Mautic Documentation

Mautic ドキュメンテーション

イントロダクション

本文書はオープンソースのマーケティングオートメーションツールであるMautic のドキュメンテーションです。ドキュメントのコードはオープンソースであり誰でも入手が可能です。この文書もまたオープンソースです。本情報に改善が必要であると考える方々の支援をお待ちしています。

PDF 版をダウンロード

このリンクをクリックして PDF 版をダウンロードしてください。

ドキュメンテーションの編集について

このレポジトリは Gitbook 向けのソースコードで www.mautic.org/docs 上で公開されます。ソースコードは GitHub 上で共有されており,Mautic のコードをプログラマが編集するのと同じように誰でも編集が可能となっています。

本文書の管理に Git を使う理由

  • 履歴. 過去のバージョンへアクセスができ,どのようなテキストだったか確認ができるため。
  • 著者. 一行一行ごとに著者が誰であるか確認できるため。
  • コミュニティ貢献. 同一文書で作業をしていても他人の文章を削除するミスを心配する必要がないため。

Git に関する、クローン、変更、コミット、プッシュなどの知識が必要ですが、 GitHub のウェブインターフェイス上でもファイルを直接変更することもが可能です。Gitを既に使いこなしているのであれば、お好きな方法で。まだであれば、下記の方法をお勧めします。

ブラウザ上でドキュメントを編集する

  1. 自分のアカウントにこのレポジトリをフォーク し、編集できるようにしてください。
  2. 編集したいファイルを選択してください。選択するとファイル構造が下の方に表示されます。ファイルの中身がどのようになっているかを確認するためにまず README.md ファイルをクリックして編集してみましょう。
  3. README.md の中身が表示されます。上の方には鉛筆アイコンの Edit this file アイコンが表示されます。このアイコンをクリックしましょう。
  4. コンテンツは Markdown フォーマット で書かれています。 とても簡単なテキストベースのフォーマットです。
  5. ファイルに変更を加えてください。たとえば末尾にThis is my first contribution (これが最初の貢献)と加えてみて下さい。
  6. 変更を加えたときにはページをスクロールすると Commit changes (変更内容をコミットする) というフォームがあります。変更をした旨を伝えることはとても重要です。変更を保存するには何を変更したのかそしてなぜ変更したのかを伝えなくてはなりません。たとえば テストのために一行を追加した と入力してください。入力だけで保存はまだしないでください!
  7. GitHub のウェブインターフェイスは Git の全ての機能を提供していないため,ファイルを元の状態へ復元する簡単な方法がありません。復元するにはファイルへ追加された行を削除する別のコミットを作らなくてはなりません。これではコミットの履歴が見にくくなります。代わりに新しいブランチを作りましょう。そのためにCreate a new branch for this commit and start a pull request. (新規ブランチを作成する) というチェックボックスがあります。ブランチには名前を付けなくてはなりません。{ユーザ名}-patch-1 とすでに入力されているでしょう。これを{ユーザ名}-test と変更しましょう。変更したら Propose file change (ファイルの変更を申請する)をクリックしてください。
  8. 自分のレポジトリへは変更がすぐに反映されます。公式のレポジトリへ変更を申請するにはプルリクエスト(PR) を送らなくてはなりません。すでにプルリクエストのページへリダイレクトされているはずです。申請した変更内容を書き加えて Create pull request (プルリクエストを作成する)をクリックしてください。テストのプルリクエストは送らないでください。

テストの後にブランチをクリーンにするには Branch (ブランチ) セクションへ移動しテストブランチを削除してください。

ファイル構造について

前セクションでは README.md ファイルについて作業をしました。このファイルは GitHub レポジトリのホームページに表示されているのですぐに内容を読めるでしょう。Mautic のドキュメンテーションにかんする内容は書かれていません。

SUMMARY.md ファイルはドキュメンテーションの目次を定義しています。ドキュメンテーションへ新しくページを追加する場合はタイトルとリンクをこのファイルへ定義しなくてはなりません。現在のメニューにある項目へ追加するためのとても単純な方法です。

フォルダーは同じトピックをひとまとめにしたものです。 アセットフォルダを開いてみてください。アセット用の README.md がでてきます。このファイルはアセットメニューをクリックした際に表示されるコンテンツです。 manage_assets.mdファイルがサブファイルです。メディア サブフォルダへ md ファイルで使われている画像をまとめます。

リンク

他の場所にあるドキュメントへリンクを張りたい場合がよくあると思います。 Markdown フォーマットではリンクはこのように表示されます:

[リンクのタイトル](http://example.com)

これは絶対 URL を使った外部サイトへのリンクを貼る方法です。ドキュメント内部へのリンクを張るには相対リンクを使います:

[次のステップ](./../plugins/integration_test.html)

このリンクは md ソースファイルから生成される ドキュメンテーションのウェブサイト内の plugins/integration_test.html へのリンクが作成されます。

画像

上でも書いたように画像はメディアサブフォルダへ入れてください。画像は GitHub ウェブインターフェイス上からはアップロードできないので,パブリックな URL へアップロードしてそこへのリンクを貼ってください。

![画像のオルタナティブテキストを入力](http://example.com/images/apple.png "画像のツールチップテキストを入力")

またはドキュメンテーションのレポジトリへアップロード済みの画像を表示させたい場合は相対パスを使うこともできます:

![画像のオルタナティブテキストを入力](/assets/media/assets-newcategory.png "画像のツールチップテキストを入力")