---
# System prepended metadata

title: quantopian-doc-ja 翻訳者メモ
tags: [quantopian, quantopian-doc-ja]

---

# quantopian-doc-ja 翻訳者メモ

###### tags: `quantopian` `quantopian-doc-ja` 


以下メモ

## 1 翻訳者が新しい branch を作る
+ 新しいブランチ名は、どのドキュメントをどこまで訳するのかわかる形で作る。例：
    + tutorial の場合: **tutorial3_alphalens_lesson1_to_5**
    + lectures の場合: **lecture1_introduction_to_research** 
+ １つのブランチで、Tutorialであれば全レッスン、Lectures であれば1レクチャーを翻訳する

### ブランチの切り方
ブランチは、ローカルでもGithub上でも切れます。お好きな方でどうぞ。
+ Local terminalでの切り方
    ```bash
    $ git pull --rebase
    $ git checkout -b tutorial3_alphalens_lesson1_to_5
    ```
+ github上での切り方: 
    1. master を選んで▼を押す
    ![](https://i.imgur.com/Pirkzsj.jpg)
    1. 新 branch 名を入れて create branch を押す
    ![](https://i.imgur.com/P1c6JCO.jpg)



## 2 ローカルの作業

1. 初めての方は， git clone 
1. （ブランチを github で切った人だけ）
    ```bash=
    # フェッチして切ったブランチを取り込む
    $ git fetch
    From github.com:tokyoquantopian/quantopian-doc-ja
     * [new branch]      tutorial3_alphalens_lesson1_to_5 -> origin/tutorial3_alphalens_lesson1_to_5

    # 新ブランチに切り替え
    $ git checkout tutorial3_alphalens_lesson1_to_5 

    # 切り替わった事を確認
    $ git status
    ブランチ tutorial3_alphalens_lesson1_to_5
    Your branch is up to date with 'origin/tutorial3_alphalens_lesson1_to_5'.
    ```
1. `./notebook` 下にある `notebook.rst`をコピーして、`./source`にうつして、リネーム。
    + 例：
        1. `notebooks/tutorials/3_alphalens_lesson_2/notebook.rst`コピー
        1. `source/tutorial`にペースト
        2. ペーストした、`notebook.rst` を `3_alphalens_lesson_2.rst` にリネーム
        ```bash
        # つまりこういうことです。
        $ cp notebooks/tutorials/3_alphalens_lesson_2/notebook.rst source/tutorial/
        $ mv source/tutorial/notebook.rst source/tutorial/3_alphalens_lesson_2.rst
        ```
    + リネームは、コピーもとのディレクトリ名にしてください
1. （時々）翻訳するべき rst ファイルが `tutorials` に無い場合があります。その時は、直接`source/tutorial`配下に、 rst ファイルを作成して下さい。
    + 例：今回 `3_alphalens_lesson_1`がなかった
        1. `source/tutorial/3_alphalens_lesson_1.rst` を作成
        1. https://www.quantopian.com/tutorials/alphalens#lesson1 の内容をコピペして翻訳を作成
3. index.rst に 追記する。
    + tutorialであれば`./source/tutorial/index.rst`、lectures であれば、` source/lectures/index.rst` にこれから翻訳する
    + 例：上記のファイルを追記する
    ```rst=
    .. _tutorial:

    ===============
    Getting Started
    ===============

    .. toctree::
       :maxdepth: 2
       :caption: Contents:

       1_getting_started_lesson1  
       〜
       〜

    ==========
    Alphalens
    ==========

    .. toctree::
       :maxdepth: 2
       :caption: Contents:

       3_alphalens_lesson_1.rst
       3_alphalens_lesson_2.rst
       3_alphalens_lesson_3.rst
       3_alphalens_lesson_4.rst
       3_alphalens_lesson_5.rst
   
   
    ```
1. 一度ビルドする
    ```bash=
    # 仮想環境にはいる
    $ source .venv/bin/activate
    # ビルド
    $ make html
    ```
1. add / commit / push する
    ```bash
    $ git add source/
    $ git commit -m "Got all the rst files to tranlate"

    $ git status
    ブランチ tutorial3_alphalens_lesson1_to_5
    このブランチは 'origin/tutorial3_alphalens_lesson1_to_5' よりも1コミット進んでいます。
      (use "git push" to publish your local commits)
      
    $ git push
    ```
## 3 Draft Pull Request を作成する
(参照：[WIPの代わりにDraft Pull Requestを利用する (GitHub) - Qiita](https://qiita.com/tatane616/items/13da1b6797a7b871ad58))
1.  https://github.com/tokyoquantopian/quantopian-doc-ja > 自分のブランチに切り替える
2. New Pull request 押す
    ![](https://i.imgur.com/SnuPIfK.jpg)
3. 緑のボタンを押して、**Create Draft pull request** を選ぶ。
    ![](https://i.imgur.com/4p8UtCD.jpg)
1. Titleは、翻訳するところ全体を表す表現にしてください。
4. メモ欄に下記をコピペ
    ```
    - [ ] 翻訳
    - [ ] 査読
    - [ ] 日本語警察
    - [ ] ユーザレビュー
    ```
5. DraftタグがついていればOK。作業が完了したら **[Ready for review]** を押せば普通のPull Requestに戻るが、PR→Draftには戻せないらしいので注意
    ![](https://i.imgur.com/5YHVOY6.jpg)


## 4 ガシガシ翻訳開始






