agektmr edited this page Apr 4, 2013 · 14 revisions

このレポジトリは AngularJS のドキュメントを日本語化するために有志が集まり作られているものです。
ご興味ある方はこちらのメーリングリストにご参加下さい。

翻訳への協力方法

  • 予めセクションを区切って担当を割り振り、自由に翻訳をスタート。
  • wikiページを用意し、そこで誰が何に取り組んでいるかを分かりやすく掲示。
  • 完了した翻訳は PullRequest で監訳に回され、チェックされたものから順に pull される
  • 担当範囲の翻訳を終えた人は、空いている区分を新たに担当するか、他の人を手伝う

翻訳にご協力頂ける方はこちらから担当範囲を申請して下さい。

もし、進め方がよくわからないという時はこちらに推奨作業ワークフローが書いてありますので参考にどうぞ。

ドキュメントの生成方法

必要なもの

  • node (バージョン不明)
  • git

ビルド手順 (必要です)

  1. まずは git でレポジトリをcloneしてきます
git clone git@github.com:angularjs-jp/angular.js.git
  1. できた angular.js ディレクトリに移動し、必要な node モジュールをインストールします
sudo ./init-repo.sh
  1. ソースコードをビルドします
rake package

ここまででひと通り環境構築は完了です。次にドキュメントの生成方法です。これは今後翻訳作業を行った後に繰り返し行うものになるはずなので、重要です。(以下は全てangular.jsディレクトリ直下という前提です)

ドキュメントサイト生成手順

  1. ソースコードと既存の ngdoc.js を元に静的HTMLファイルを生成するスクリプトを起動します
    ./gen_docs.sh

    Testing, then building documentation...
    ........................................................
    
    Finished in 0.079 seconds
    56 tests, 93 assertions, 0 failures
    
    
    Generating AngularJS Reference Documentation...
    DONE. Generated 211 pages in 4828ms.
  1. これで angular.js/build/docs/ 配下に静的なドキュメントサイトのファイルが展開されました。
  2. node ウェブサーバーを起動します
    ./nodeserver.sh
  1. 下記のURLにアクセスします
    http://localhost:8000/build/docs/tutorial

ドキュメントサイトがローカルのURLで表示されたら成功です。リンクによっては本家に移動してしまうので注意して下さい。

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.