Let’s translate FuelPHP docs!

16,317 views

Published on

FuelPHP のドキュメント和訳に参加しよう!

Published in: Technology
0 Comments
6 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
16,317
On SlideShare
0
From Embeds
0
Number of Embeds
13,798
Actions
Shares
0
Downloads
0
Comments
0
Likes
6
Embeds 0
No embeds

No notes for slide

Let’s translate FuelPHP docs!

  1. 1. Let’s translate FuelPHP docs! Sep. 23, 2012 FuelPHP 勉強会 東京 sho <sho@codeigniter.jp>
  2. 2. とはSee: http://slideshare.net/akagisho/
  3. 3. Documentation
  4. 4. Documentationかなり充実してます • 全ページ数: $ find . -name *.html | wc -l 143
  5. 5. Documentationgithub で管理
  6. 6. Documentationgithub で管理 = だれでも加筆・修正依頼できる
  7. 7. 和訳の状況
  8. 8. 和訳の状況github で管理 Fork ここで管理 Fork Pull Request your name
  9. 9. 和訳の状況 参加者: 実質6人くらい? (´・ω:;.:… ……https://github.com/NEKOGET/FuelPHP_docs_jp/pulls
  10. 10. 和訳の状況[FuelPHP] と [Oil] はだいたい済み他はまだまだ
  11. 11. Let’s translate!
  12. 12. 和訳するメリット
  13. 13. 和訳するメリット Fuel がメジャーになる!
  14. 14. Fuel がメジャーになると…日本語情報が増える 案件に採用しやすくなる 採用実績が増える
  15. 15. 和訳に参加するメリット
  16. 16. 和訳に参加するメリット Fuel 力が付く!
  17. 17. 和訳に参加するメリット なんかカコ(・∀・)イイ!!http://jigokuno.com/
  18. 18. 英語苦手だし… Fuel 力 & git 力 > 英語力• docs の英語自体はそんなに難しくない• 雰囲気が間違ってなければいい (?) • 正解はソースコード
  19. 19. 英語苦手だし…わからないところは豪快に skip • 考えこむのは時間の無駄 • できることからコツコツと
  20. 20. ここから本題 どうやればいいの?
  21. 21. 和訳の流れ Fork / Pull pull Request your name clone / pull push • 作業用 ブランチ作成 • 和訳 • commit
  22. 22. NEKOGET/FuelPHP_docs_jp を forkhttps://github.com/NEKOGET/FuelPHP_docs_jp
  23. 23. ローカルに複製 (clone)$ cd htdocs/ # 適当なディレクトリに移動$ git clone https://github.com/<github ユーザ名>/ ¥ FuelPHP_docs_jp.git [作成するディレクトリ名]
  24. 24. 作業用ブランチの作成• 今回は form1 という名前でブランチを作成 $ cd FuelPHP_docs_jp/ $ git checkout –b form1• できたか確認 $ git branch -l 1.3/develop_japanese * form1
  25. 25. 和訳する
  26. 26. commit して push• インデックスに変更内容を登録 $ git add -u• ローカルに commit $ git commit –m "コミットメッセージ"• リモートに push $ git push origin form1
  27. 27. Pull Requestgithub にログインして、自分のページにアクセス Pull Request をクリック
  28. 28. Pull Request さっき作成した ブランチを選択
  29. 29. 気をつけること
  30. 30. Fork したリポジトリは古くなる• Fork 元の変更のマージが必要 本家の merge 最新 みんなの PR 古い ……
  31. 31. Fork 元の変更のマージ• フォーク元を remote に追加 $ git remote add upstream ¥ git://github.com/NEKOGET/FuelPHP_docs_jp.git• フォーク元の更新を取得 $ git fetch upstream $ git merge upstream/1.3/develop_japanese• 作業用ブランチに反映 $ git checkout form1 $ git rebase upstream/1.3/develop_japanese
  32. 32. 日本語訳の揺れ、フォーマットhttps://github.com/NEKOGET/FuelPHP_docs_jp/wiki/日本語訳の揺れ
  33. 33. Tips
  34. 34. 便利なツールGitHub for Mac
  35. 35. 便利なツールexcite 翻訳 http://www.excite.co.jp/world/英辞郎 http://www.alc.co.jp/
  36. 36. 一括置換複数ファイルを一括置換 $ find <対象ディレクトリ> -name ¥ <ファイル名のパターン>’ | ¥ xargs sed -i ¥ s/<置換対象の正規表現>/<置換後の文字列>/g※ GNU sed じゃないとたぶんできないhttp://blog.akagi.jp/archives/2661.html
  37. 37. ポイント自分が使いたい機能から順に • モチベーションの維持 • 他の人からも需要あるかも
  38. 38. コミットメッセージの書き方 現状特に決まりはない もし英語で書くなら (案): • 命令形 • 大文字で始める • ピリオドを付けない e.g.) Add ignore line for textmate project files参考: 英語でコミットを書こう https://speakerdeck.com/u/pwim/p/ying-yu-dekomitutowoshu-kou
  39. 39. ハマりそうなところ• ある branch から ある branch に対して、同時に Pull Request できるのは1つまで • PR が消化されないまま push すると、勝手に 結合される • 作業内容ごとに branch を作ればいい
  40. 40. ハマりそうなところ• FuelPHP_docs_jp を Fork したアカウントでは、 fuel/docs を Fork できない • ただし直接 Pull Request できる Fork Fork your name
  41. 41. 本家へのフィードバック
  42. 42. 原文に誤りを見つけたら• 本家にフィードバックしよう• 結構ある
  43. 43. 本家へのフィードバック• リモートの “1.3/develop” を checkout $ git checkout -b 1.3/develop origin/1.3/develop• 本家の更新を merge (略)• 編集して commit• Pull Request
  44. 44. 参考情報Twitter #FuelPHP参考書籍
  45. 45. おわり

×