改訂作業中のマニュアル

改訂作業の進み具合の最新情報については、

  • Github のissue 975 を参照してください。

 マニュアルを書く同志を募集しています

マニュアルを書く同志を募集しています。我こそはという方、ぜひ、ご参加ください。

参加方法

  1. github のアカウントがなければ作成する
  2. 連絡先宛てにEnjuマニュアル作成参加の旨、githubのアカウントとともにご連絡ください。連絡はメールでもtwitterでもどちらでもかまいません。
  3. github の next-l/manual チームに追加された旨の連絡が数日中に届きます。これで、githubのnext-l/manualレポジトリにアクセス権限(読み取り、書き取り)ができ、マニュアルの更新ができるようになります。

 マニュアルの更新方法

github, git, Markdown, jekyllについては知っているものとして説明します)

  • 1. Githubからマニュアルのソースファイルを取得する
    • git clone https://github.com/next-l/manual.git
    • これで、manual フォルダができる
    • .md ファイルがマニュアルの実際のファイル 。Markdown 方式で書いています
  • 2. 環境をととのえる
    • cd manual
    • bundle update
      • 必要なソフトがインストールされます
  • 3. マニュアルを修正します
    • お好きなエディタで編集して内容を書いてください。
  • 4. (任意)jekeyll buildコマンドでプレビューできます。
    • _sites/ ディレクトリ下に実際に閲覧されるHTMLが出力されていますので、見栄えを確認できます。
  • 5. 反映させる
    • git commit および git push コマンドで Github サイト上に反映させることができます。
    • push する権限が無い場合はML等でリクエストしてください。または、Forkしてから修正内容を pull request していただいても構いません)
    • 不明な点は、Issue登録するか、MLで質問をお願いします。

マニュアルのファイル構造

マニュアルの改訂作業をスムーズにするために、内容に応じて複数のファイルに分割して作業をすすめています。

  • テキストファイル
    • 本文 manual/バージョン/*.md
      • 例: manyuaru/1.1/*.md
    • 全体の目次 https://next-l.github.io/manual/ → manual/index.md
    • 各マニュアルの目次 manual/_includes/*/toc.md
      • 例:利用者マニュアル https://next-l.github.io/manual/1.2/enju_user.html → manual/_includes/enju_user/toc.md
      • 各マニュアルの目次はバージョン共通ですので、バージョンによって変わる場合は別ファイルにする処理をしてください。
  • 画像ファイル
    • 画像ファイルは manual/assets/images/バージョン/*.png
      • 例: manyuaru/1.1/*.png

関連リンク

公開中のマニュアル


編集ログイン 最終更新のRSS