diff --git a/README.md b/README.md index 0595611..463dd0f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ ![top](images/top.jpg) -[翻訳コミュニティ月例ミートアップ 用のイベント及び翻訳手順の説明サイトです](https://mozilla-japan.github.io/mdn-translation-guide/)。 +- https://mozilla-japan.github.io/mdn-translation-guide/ + - ここは MDN 翻訳コミュニティ月例ミートアップ用の資料置き場です。 + - https://github.com/mozilla-japan/mdn-translation-guide で管理されています。 diff --git a/SUMMARY.md b/SUMMARY.md index 36cf99b..ec42d52 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,22 +1,20 @@ # Summary -* [Introduction](README.md) - * [翻訳イベントのタイムスケジュール](time-schedule.md) - * [Mozilla Japanese コミュニティ Slack](community-slack.md) - * [GitHubと参加者コミュニケーション用 Docs](communication.md) - * [便利なリンク集](link.md) - * [翻訳支援ツール(非推奨：MDN の Wiki 編集ツールが対象です。(2020 年 12 月以降利用不可))](deprecated-tools.md) - * [翻訳の流れ](translation-flow.md) - * [0.導入](translation-introduction.md) - * [1.記事の選定](select-articles.md) - * [2.GitHub にイシューを立てる](git-issue.md) - * [3.リポジトリをforkする](repository-fork.md) - * [3-1.シンプルな編集の場合](simple-edits.md) - * [3-2.ローカルで編集をする](local-edits.md) - * [3-3.Pull Request を出す](pull-request.md) - * [3-4.fork元のリポジトリと同期する](synchronize-forked-repository.md) - * [翻訳の流れ（補足）](supplement.md) - * [3-5.翻訳開始! - 参考リンク集](link.2.md) - * [4-1.ローカルプレビュー環境の構築](local-dev.md) - * [4-2.新規翻訳の手順（index.md の作成）](new-translation-procedure-1.md) - * [4-3.新規翻訳の手順（index.md の作成）](new-translation-procedure-2.md) +- [MDN 月例ミートアップ - 翻訳ガイド](README.md) +- [月例ミートアップについて](meetup/index.md) + - [Mozilla コミュニティの Slack](meetup/community-slack.md) + - [タイムスケジュール](meetup/time-schedule.md) + - [自己紹介シートについて](meetup/self-introduction.md) +- [翻訳作業の流れ](translation/index.md) + - [0. 準備するもの](translation/0_preparation.md) + - [1. 記事を選定する](translation/1_choose-article.md) + - [2. 作業を宣言する](translation/2_declare-task.md) + - [3. fork リポジトリを用意する](translation/3_fork-repository.md) + - [4. fork リポジトリを clone する](translation/4_clone-repository.md) + - [5. 日本語記事ページを新規作成する](translation/5_new-ja-file.md) + - [6. 日本語記事ページを編集する](translation/6_edit-ja-file.md) + - [7. Pull Request を作成する](translation/7_create-pull-request.md) +- [補足情報](misc/index.md) + - [便利なリンク集](misc/links.md) + - [軽微な修正を行いたい場合](misc/for-minor-change.md) + - [yari リポジトリでの環境構築](misc/yari-repository.md) diff --git a/communication.md b/communication.md deleted file mode 100644 index 7d2d93b..0000000 --- a/communication.md +++ /dev/null @@ -1,8 +0,0 @@ -# GitHubと参加者コミュニケーション用 Docs - -翻訳開始時にこちらにイシューを新規に立ててくささい -https://github.com/mozilla-japan/translation/issues/ -※被りがないよう既存イシューを確認してから翻訳宣言しましょう - -イシューを立てたらこちらにリンクを貼る（当日コミュニケーション用Docs） -[MDN翻訳オフラインミートアップ 情報交換掲示板](https://docs.google.com/document/d/16cKB9t8Deiv0emx01jvy1TJPIFQrqd-EUxZMRUvhlj0/edit) diff --git a/community-slack.md b/community-slack.md deleted file mode 100644 index 3aa0bf3..0000000 --- a/community-slack.md +++ /dev/null @@ -1,5 +0,0 @@ -# Mozilla Japanese コミュニティ Slack -- 差し支えなければこちらからご参加ください -- 現場のやり取りや日頃のコミュニケーションをこちらでしています -- [Mozilla Japanese Community Slack (の参加用リンク) ](https://join.slack.com/t/mozillajp/shared_invite/enQtMjI2NDMwODUwNzY5LTIxZTg0YzJhMjFiYjc3NDIzNzQ3NTgyZmI1ZGQ2YWNhZmRlMzdlZWVlYTc3OGJiOGYzZTE2NThjYzFhMGMwYzQ) -- ワークスペースに参加したら、チャンネル一覧から [#translation](https://app.slack.com/client/T578ZUDLM/C5N6SFQMP) を見つけてそちらにも参加してください。 diff --git a/deprecated-tools.md b/deprecated-tools.md deleted file mode 100644 index 96ba41c..0000000 --- a/deprecated-tools.md +++ /dev/null @@ -1,4 +0,0 @@ -## 翻訳支援ツール(非推奨：MDN の Wiki 編集ツールが対象です。(2020 年 12 月以降利用不可)) - -#### 頻出訳語の自動翻訳やタグの自動置換など、翻訳作業の効率化をしてくれるUser Scriptです、こちらを参考に利用してみてください。 -- [MDN翻訳お役立ちツール](https://github.com/mozilla-japan/translation/tree/master/MDN) diff --git a/git-issue.md b/git-issue.md deleted file mode 100644 index 9965ea8..0000000 --- a/git-issue.md +++ /dev/null @@ -1,8 +0,0 @@ -# 2.GitHub にイシューを立てる - -#### こちらにイシューを新規に立て、どこを翻訳するか宣言✋してください -- https://github.com/mozilla-japan/translation/issues/ -- ※被りがないようチェックしてから宣言をおねがいします！ - -##### イシューを立てたらこちらにgithub issueのリンクを貼る（イベント当日の情報交換用掲示板） -- https://docs.google.com/document/d/16cKB9t8Deiv0emx01jvy1TJPIFQrqd-EUxZMRUvhlj0/edit diff --git a/images/foxkeh.png b/images/foxkeh.png deleted file mode 100644 index b418023..0000000 Binary files a/images/foxkeh.png and /dev/null differ diff --git a/images/local-boot.png b/images/local-boot.png deleted file mode 100644 index 1d4f836..0000000 Binary files a/images/local-boot.png and /dev/null differ diff --git a/images/translate.png b/images/translate.png deleted file mode 100644 index 0d20eaf..0000000 Binary files a/images/translate.png and /dev/null differ diff --git a/link.2.md b/link.2.md deleted file mode 100644 index 577be61..0000000 --- a/link.2.md +++ /dev/null @@ -1,13 +0,0 @@ -# 3-5.翻訳開始! - 参考リンク集 - -### 翻訳時の用語や表記の仕方、文体などに関して参照してください。 - -### 【MDN 翻訳を始めよう】 - -- [MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) -- [表記ガイドライン](https://github.com/mozilla-japan/translation/wiki/Editorial-Guideline) -- [L10N ガイドライン](https://github.com/mozilla-japan/translation/wiki/L10N-Guideline) -- [Mozilla 用語集](https://github.com/mozilla-japan/translation/wiki/Mozilla-L10N-Glossary) -- [日本語の文体](https://docs.google.com/spreadsheets/d/1y-hC-xMXawCgcYZwJDnvuSlAOTgMRLLyqXurpYkJbYE/edit#gid=0) - -![foxkeh](images/foxkeh.png) diff --git a/link.md b/link.md deleted file mode 100644 index 95b1237..0000000 --- a/link.md +++ /dev/null @@ -1,15 +0,0 @@ -# 便利なリンク集 - -### ※本スライド後半の「翻訳の流れ」も併せてご覧ください - -### 【MDN 翻訳を始めよう】 - -- [MDN で始めよう - MDN プロジェクト | MDN](https://developer.mozilla.org/ja/docs/MDN/Getting_started#Possible_task_types) -- [【Mozilla ドキュメント翻訳の始め方】](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) - -#### 翻訳時の用語や表記の仕方、文体などに関して参照してください。 - -- [表記ガイドライン](https://github.com/mozilla-japan/translation/wiki/Editorial-Guideline) -- [L10N ガイドライン](https://github.com/mozilla-japan/translation/wiki/L10N-Guideline) -- [Mozilla 用語集](https://github.com/mozilla-japan/translation/wiki/Mozilla-L10N-Glossary) -- [日本語の文体](https://docs.google.com/spreadsheets/d/1y-hC-xMXawCgcYZwJDnvuSlAOTgMRLLyqXurpYkJbYE/edit#gid=0) diff --git a/local-dev.md b/local-dev.md deleted file mode 100644 index b579e83..0000000 --- a/local-dev.md +++ /dev/null @@ -1,28 +0,0 @@ -# 4-1.ローカルプレビュー環境の構築 - -1. 手元に作業用ディレクトリを用意します。 - ``` - $ mkdir ~/path/to/mdn_repos - $ cd ~/path/to/mdn_repos - ``` -1. 作業に必要な3つのリポジトリを clone します。 - - https://github.com/mdn/yari - - https://github.com/mdn/content - - fork した translated-content リポジトリ -1. **確認** これで作業用ディレクトリの中に、3つのディレクトリ（リポジトリ）がある状態になっています。 - ``` - [mdn_repos] $ ls - content translated-content yari - ``` -1. yari ディレクトリ内に .env ファイルを作成し、次のような内容を書き込みます。 - ``` - [yari] $ cat .env - CONTENT_ROOT=../content/files - CONTENT_TRANSLATED_ROOT=../translated-content/files - ``` -1. yari ディレクトリで、yarn install を一度実行した後、yarn dev を実行するとプレビュー環境が作られます。 - ``` - [yari] $ yarn install - [yari] $ yarn dev - ``` -1. yarn dev は少し時間がかかりますが、完了すると http://localhost:3000/ にアクセスできるようになります。 diff --git a/local-edits.md b/local-edits.md deleted file mode 100644 index bae17b3..0000000 --- a/local-edits.md +++ /dev/null @@ -1,63 +0,0 @@ -# 3-2.ローカルで編集をする - -原文はこちら：[setup](https://github.com/mdn/content#setup) -こちらも参考に：[MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) - - -[前ページ](simple-edits.md)で fork したリポジトリ を clone してローカルに置きます。 -- ※最新のmainブランチを取り込んでいる状態にします（[前ページ](simple-edits.md)を参照） -- 例：/Users/path/to/repos/mdn/content -- 例：/Users/path/to/repos/mdn/translated-content -- ターミナルで、以下のコマンドを実施します - ``` - $ cd /Users/path/to/repos/mdn/content - - # 以下、yarn コマンドが使える環境である必要があります。yarn の使い方が分からなければSlackで聞いてください。 - $ yarn install - - # .env ファイルを作成 - # CONTENT_TRANSLATED_ROOT={translated-contentリポジトリ内のfilesディレクトリ} - - # 例：/Users/path/to/repos/mdn/translated-content/files - $ content git:(main) cat .env - CONTENT_TRANSLATED_ROOT=/Users/path/to/repos/mdn/translated-content/files - - # http://localhost:5042 にアクセス - $ yarn start - ``` -- MDN の Writer's home page が表示されます🎉 - ![local-boot](images/local-boot.png) - -- http://localhost:5042/ja/ に行き、翻訳したい該当ページを開いておきます - - 実際にはページが存在しているのに、初回アクセス時に Page not found となる場合があります - - その場合はブラウザでページをリロードすれば表示されます -- 3−1で clone していた mdn/translated-content をエディタで開き、翻訳したい該当ファイルを編集します - - または、http://localhost:5042/ja/ の該当ページから［Open in your editor］ボタンで該当ファイルをエディタで開くことができます -- 編集すると、http://localhost:5042/ja/ の該当ページが更新されますので、確認しながら編集を行います - - -##### ※ ［Open in your editor］ボタンからエディタを開く場合、3-2 で作った .env ファイルに使用するエディタを指定しておくことができます。 -##### 例：EDITOR=code （VSCodeで開きたい場合） - - -### 翻訳するページのファイルがなく、追加する場合 - -1. まず、自分のブランチで作業していることを確認します。　 -1. PR作業用にトピックブランチを作成します。 - ``` - # コマンドで、自分が作業しているブランチが * 付きで表示されます。 - git branch -a - # ↓ ブランチ名は自由ですが、作成したissue番号などでもよいです。 - git checkout -b issue-123 - ``` -1. 翻訳対象になるファイルを、en-US から ja にコピーします。階層内の位置を、en-US と同じにしてください。 -1. 翻訳を進めます。　※前のページと同じように、対象ファイルを編集。 - ``` - # 編集したファイルを、git の管理対象に加え、 - git add files/ja/folder/you/added - # コミット - git commit - # github上のリポジトリに反映します。 - git push origin issue-123 - ``` -1. プルリクエストを作成し、MDNのリポジトリに反映を要請します。 diff --git a/meetup/community-slack.md b/meetup/community-slack.md new file mode 100644 index 0000000..83a5c02 --- /dev/null +++ b/meetup/community-slack.md @@ -0,0 +1,8 @@ +# Mozilla コミュニティの Slack + +- Japanese Mozilla community group の Slack があり、その中の #translation チャンネルで翻訳に関する情報交換をしています。 +- [Slack 参加用リンク](https://join.slack.com/t/mozillajp/shared_invite/enQtMjI2NDMwODUwNzY5LTIxZTg0YzJhMjFiYjc3NDIzNzQ3NTgyZmI1ZGQ2YWNhZmRlMzdlZWVlYTc3OGJiOGYzZTE2NThjYzFhMGMwYzQ) + - 月例ミートアップでは Slack 上でやり取りを行うため、ぜひご参加ください。 +- Slack のワークスペースに参加したら、チャンネル一覧から [#translation](https://app.slack.com/client/T578ZUDLM/C5N6SFQMP) を見つけて、そちらに参加してください。 + - この Slack は MDN 翻訳コミュニティ以外でも使われています。 + - この翻訳コミュニティでの作業に関することは #translation チャンネルに書き込んでください。 diff --git a/meetup/index.md b/meetup/index.md new file mode 100644 index 0000000..b446d07 --- /dev/null +++ b/meetup/index.md @@ -0,0 +1,7 @@ +# 月例ミートアップについて + +- MDN 翻訳コミュニティ月例ミートアップは、2018年2月21日より開催されています。 +- [【第１回！】みんなで MDN を翻訳しよう！翻訳コミュニティ月例ミートアップ！（2018-02-21）](https://mozilla.doorkeeper.jp/events/70796) +- [Mozilla Japan コミュニティ - イベントページ | Doorkeeper](https://mozilla.doorkeeper.jp/) +- 2020年3月20日（第20回）より、コロナ禍のためオンラインのみの開催となりました。 + - 開催日は「20日に最も近い土曜日」としていることが多いです。 diff --git a/meetup/self-introduction.md b/meetup/self-introduction.md new file mode 100644 index 0000000..6544d33 --- /dev/null +++ b/meetup/self-introduction.md @@ -0,0 +1,7 @@ +# 自己紹介シートについて + +- 月例ミートアップでは、15:00 からの中間報告会で自己紹介をしています。 +- 自己紹介の内容を記録に残すために、専用のスプレッドシートを用意しています。 + - [MDNミートアップ：自己紹介シート](https://docs.google.com/spreadsheets/d/1N73mciqvlQbuC4457OMteS-TXDldj75XybDKfK8CToI/edit#gid=0) +- 差し支えなければ「自己紹介テンプレート」をコピーして、ご自身のシートを作成ください。 +- シートの作成は必須ではありません。作成しない場合は中間報告会のタイミングで Slack に自己紹介を書き込んでください。 diff --git a/meetup/time-schedule.md b/meetup/time-schedule.md new file mode 100644 index 0000000..f36052c --- /dev/null +++ b/meetup/time-schedule.md @@ -0,0 +1,26 @@ +# タイムスケジュール + +|時刻|内容|備考| +|:---|:---|:---| +|12:30|開場|（オフライン開催の場合）| +|13:00|Slack の #translation チャンネルに集合、点呼|[#translation チャンネル](https://app.slack.com/client/T578ZUDLM/C5N6SFQMP)| +|13:00〜13:10|簡単な挨拶、作業案内など|詳細な自己紹介は後でやる| +|〜15:00|各自作業（前半）|| +|15:00〜15:30|【中間報告会】自己紹介、困ったことなど共有|Google Meet を開催| +|〜17:00|各自作業（後半）|| +|17:00〜17:30|【最終報告会】作業報告、感想、共有など|Google Meet を開催| +|〜18:00|クローズ|（最後まで居なくても早退可）| + +## オンライン開催時の流れ + +- 13:00 になったら、Slack の #translation チャンネルに一言「初めて参加します xxxx です。よろしくお願いします。」のような発言をします。 + - 詳細な自己紹介は別途行うので、始めは簡単な発言で大丈夫です。 +- その後の案内や説明は Slack 上でチューターが行います。 +- 途中で抜けても大丈夫ですので、別の予定がある場合などはお気軽に早退してください。その際は Slack の #translation チャンネルに一言お願いします。 + +## オフライン（現地）開催時の流れ + +- 指定の会場へお集まりください。 + - オンライン参戦も可能です。 +- 上記のタイムスケジュールとは異なる時間帯に開催する場合があります。 + - 詳細は[イベント開催案内](https://mozilla.doorkeeper.jp/)をご確認ください。 diff --git a/misc/for-minor-change.md b/misc/for-minor-change.md new file mode 100644 index 0000000..04aa0c0 --- /dev/null +++ b/misc/for-minor-change.md @@ -0,0 +1,10 @@ +# 軽微な修正を行いたい場合 + +- 軽微な修正であれば、「翻訳作業の流れ」の手順を行わずに編集作業を実行する方法があります。 +- GitHub の [translated-content リポジトリ](https://github.com/mdn/translated-content/)上で、編集したいページのファイルを開きます。 + - 例えば glossary/entity を編集したければ https://github.com/mdn/translated-content/blob/main/files/ja/glossary/entity/index.md を開きます。 +- 右上の方にある「ペンシルボタン」を押して、編集を行います。 +- 編集が終わったら、編集画面の下部にある "Propose changes" のフォームにコミットメッセージを記述します。 +- "Propose changes" ボタンを押すとコミットが作成されます。 + - ペンシルボタンから編集を行うと、fork した自分のリポジトリに自動で新しいブランチが作られます。 +- Pull Request が作成できたら完了です。 diff --git a/misc/index.md b/misc/index.md new file mode 100644 index 0000000..bbc21e8 --- /dev/null +++ b/misc/index.md @@ -0,0 +1,3 @@ +# 補足情報 + +- その他の補足情報を残しておきます。 diff --git a/misc/links.md b/misc/links.md new file mode 100644 index 0000000..8e26e9b --- /dev/null +++ b/misc/links.md @@ -0,0 +1,27 @@ +# 便利なリンク集 + +翻訳作業に関連するリンクの一覧です。 + +- 月例ミートアップ関連 + - [MDN 月例ミートアップ - 翻訳ガイド](https://mozilla-japan.github.io/mdn-translation-guide/) + - [Mozilla Japan コミュニティ | Doorkeeper](https://mozilla.doorkeeper.jp/) + - [Slack | translation | Japanese Mozilla community group](https://app.slack.com/client/T578ZUDLM/C5N6SFQMP) + - [MDN翻訳ミートアップ 情報交換掲示板](https://docs.google.com/document/d/16cKB9t8Deiv0emx01jvy1TJPIFQrqd-EUxZMRUvhlj0/edit) + - [MDN 翻訳月例ミートアップ・レビュー待ちリスト](https://docs.google.com/document/d/1yqCjvvN8md6qca-WWZsYbPTIM8AFzBjFGYqPQ2t8q4U/edit) + - [MDNミートアップ：自己紹介シート](https://docs.google.com/spreadsheets/d/1N73mciqvlQbuC4457OMteS-TXDldj75XybDKfK8CToI/edit#gid=0) + - [MDN翻訳ステータス一覧表](https://mdn.lavoscore.org/?regex_b=glossary&sort=size-asc&filter=not-ja) +- MDN 関連リポジトリ + - [日本語訳 GitHub Issues](https://github.com/mozilla-japan/translation/issues) + - [原文リポジトリ](https://github.com/mdn/content) + - [翻訳リポジトリ](https://github.com/mdn/translated-content) + - [デモページ用コード](https://github.com/mdn/interactive-examples) + - [ブラウザ互換性テーブル](https://github.com/mdn/browser-compat-data/) + - [yari リポジトリ](https://github.com/mdn/yari) +- MDN 翻訳を始めるにあたって + - [MDN で始めよう - MDN プロジェクト | MDN](https://developer.mozilla.org/ja/docs/MDN/Community/Contributing/Getting_started#Possible_task_types) + - [MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) +- 翻訳時の用語や表記の仕方、文体などに関して + - [表記ガイドライン](https://github.com/mozilla-japan/translation/wiki/Editorial-Guideline) + - [L10N ガイドライン](https://github.com/mozilla-japan/translation/wiki/L10N-Guideline) + - [Mozilla 用語集](https://github.com/mozilla-japan/translation/wiki/Mozilla-L10N-Glossary) + - [日本語の文体](https://docs.google.com/spreadsheets/d/1y-hC-xMXawCgcYZwJDnvuSlAOTgMRLLyqXurpYkJbYE/edit#gid=0) diff --git a/misc/yari-repository.md b/misc/yari-repository.md new file mode 100644 index 0000000..b125b44 --- /dev/null +++ b/misc/yari-repository.md @@ -0,0 +1,34 @@ +# yari リポジトリでの環境構築 + +- ローカルプレビューを行うのに content リポジトリでの `yarn start` を使う以外に、yari リポジトリでの `yarn dev` を使う方法があります。 +- yari リポジトリでローカルプレビューを行うことで、最新の yari リポジトリの状態を反映できます。 + - 例えば MDN Web Docs のデザインが変更された際や、BCD（Browser Compat Data; ブラウザーの互換性）テーブルの構造が変更された場合などに、最新の状態を反映することができます。 + +``` +// 作業用ディレクトリに移動する +[~] $ cd ~/path/to/mdn_repos + +// yari リポジトリを clone する +[mdn_repos] $ git clone git@github.com:mdn/yari.git + +[mdn_repos] $ ls +content translated-content yari + +// yari ディレクトリに移動する +[mdn_repos] $ cd yari + +// yari ディレクトリ内に .env を作成する +[yari] $ echo -e 'CONTENT_ROOT=../content/files\nCONTENT_TRANSLATED_ROOT=../translated-content/files' > .env +[yari] $ cat .env +CONTENT_ROOT=../content/files +CONTENT_TRANSLATED_ROOT=../translated-content/files + +// ローカルプレビューができるように yarn install しておく +[yari] $ yarn install + +// ローカルプレビューを起動する（`yarn start` ではなく `yarn dev` を使います） +[yari] $ yarn dev +``` + +- yarn dev は少し時間がかかりますが、完了すると http://localhost:3000/ にアクセスできるようになります。 + - content リポジトリの場合は Port:5042 でした。yari リポジトリの場合は Port:3000 が使われます。 diff --git a/new-translation-procedure-1.md b/new-translation-procedure-1.md deleted file mode 100644 index ec6c252..0000000 --- a/new-translation-procedure-1.md +++ /dev/null @@ -1,21 +0,0 @@ -# 4-2.新規翻訳の手順（index.md の作成） - -1. 翻訳したい英語版の記事を決めます。 - - 例：https://developer.mozilla.org/en-US/docs/Glossary/Entity -1. 手元の content リポジトリから index.md ファイルを探します。 - ``` - [mdn_repos] $ ls content/files/en-us/glossary/entity/index.md - ``` -1. fork した translated-content リポジトリに、英語版の index.md をコピーします。 - ``` - [repos] $ cp -r content/files/en-us/glossary/entity/ translated-content/files/ja/glossary/ - ``` -1. http://localhost:3000/ja/docs/Glossary/Entity にアクセスして、日本語版URLでページが開けることを確認します。 - - プレビュー環境を content リポジトリで作っている場合は http://localhost:5042/ja/docs/Glossary/Entity - - 英語版 index.md をコピーしたので、内容は英語になっています。 -1. ここまで確認できたら、一度 index.md をコミットします。コミットメッセージは自由ですが、適当に記載します。 - ``` - [translated-content] $ git add . - [translated-content] $ git commit -m "copied index.md from en-us" - ``` -1. 日本語翻訳作業に移ります。（次のページへ） diff --git a/new-translation-procedure-2.md b/new-translation-procedure-2.md deleted file mode 100644 index b449fad..0000000 --- a/new-translation-procedure-2.md +++ /dev/null @@ -1,17 +0,0 @@ -# 4-3.新規翻訳の手順（index.md の作成） - - -1. 好きなエディタで、tramslated-content リポジトリの対象の index.md ファイルを開きます。 - ``` - [translated-content] $ open files/ja/glossary/entity/index.md - ``` -1. メタデータ部分（Front-Matter）を編集して、不要なメタデータを削除します。 - ![translate](images/translate.png) - - 上記は ja - フロントマターから不要なメタデータを削除 の要請による作業です。 - - "title", "slug" 以外のメタデータを削除し、"l10n: sourceCommit" を追加します。 - - sourceCommit には、参考にしている content リポジトリの英語版 index.md の最新コミットIDを記述します。 - ``` - [content] $ git log files/en-us/glossary/entity/index.md - ``` -1. この作業を行った上で、本文を翻訳します。 - - 実際の参考PR： https://github.com/mdn/translated-content/pull/8025 diff --git a/pull-request.md b/pull-request.md deleted file mode 100644 index ee156c0..0000000 --- a/pull-request.md +++ /dev/null @@ -1,14 +0,0 @@ -# 3-3.Pull Request を出す - -原文はこちら：[setup](https://github.com/mdn/content#setup) -こちらも参考に：[MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) - -### 編集が終わり、確認して問題なければ、作業をコミットして、Pull Request を出します。 - -- mdn/translated-contents リポジトリの main ブランチに対して Pull Request を出します - - レビュアーは自動で設定されます -- レビュアーから修正依頼があった場合、修正します -- レビュアーに承認されると、マージされます。 - -#### マージされたら、2-1 で立てた Issue もクローズしましょう。 -#### ※ PR時のメッセージに mozilla-japan/translation#xxx （xxx は 2-1 での Issue 番号）を付けておくと、マージ時に自動で Issue がクローズされます。mozilla-japan/translation を付けないと、関係のない Issue がクローズされるので注意してください。 diff --git a/repository-fork.md b/repository-fork.md deleted file mode 100644 index 1f23210..0000000 --- a/repository-fork.md +++ /dev/null @@ -1,14 +0,0 @@ -# 3.リポジトリをforkする - -原文はこちら：[setup](https://github.com/mdn/content#setup) -こちらも参考に：[MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) - -##### 今までは翻訳をWeb上で行っていましたが、2021年より翻訳ツールが新しくなり（Yari）、GitHub上でソース管理されるようになりました。元のリポジトリをforkして編集し、プルリクエストを作成しレビュワーのレビューを通ったらマージされる（＝翻訳したページが公開される）ようになっています。 -- https://github.com/mdn/content リポジトリを fork します -- https://github.com/mdn/translated-content リポジトリを fork します - - files/ja/ が日本語用のディレクトリです - -mainブランチから自分の作業用ブランチを切り、次に進みます　※ブランチ名は自由に付けてください -※2回目以降の翻訳や、forkしてから時間がたった場合、翻訳の流れ(3-4)にある手順で、 fork したリポジトリを最新の状態にしてください。 - -その後、作業をすすめて push -> pull request します。 diff --git a/select-articles.md b/select-articles.md deleted file mode 100644 index c094d1b..0000000 --- a/select-articles.md +++ /dev/null @@ -1,18 +0,0 @@ -## 1.記事の選定 - -### 自分の興味に合う記事を選ぶ -- [MDN Web Docs](https://developer.mozilla.org/ja/) 内から翻訳したい 記事を探します。 -- 下記リンクも適宜参考にしてください。 - -### 初めてMDN翻訳をやる方におすすめ！ -#### [用語集](https://developer.mozilla.org/ja/docs/Glossary) -- 記事がとても短いのでフローを学ぶのに最適。 -- 用語集のうち日本語版が存在しないものを絞り込む方法があります。 - - https://mdn.lavoscore.org/?filter=not-ja®ex_b=glossary　（debiru さん作） - -#### ご自身の得意分野の記事 -- MDNのページ上部「Technologies」のプルダウンメニューや、右上の検索バーからご自身の得意分野の記事を探してみます。 -- リンクのページタイトルの後に「(en-US)」とついているものが、日本語ページの存在しない未訳ページになります。←2022年のサイトのデザイン変更後、この見分け方が、通用しなくなっているようです -- 翻訳の流れを掴むために、まずはなるべく短い記事を探してみるとよいでしょう。 - -##### [Mozilla Japan コミュニティの WIki](https://github.com/mozilla-japan/translation/wiki#%E9%96%8B%E7%99%BA%E8%80%85%E5%90%91%E3%81%91%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88-mdn-%E3%81%AE%E7%BF%BB%E8%A8%B3) にも記事選定のための情報があります diff --git a/simple-edits.md b/simple-edits.md deleted file mode 100644 index 2738bc4..0000000 --- a/simple-edits.md +++ /dev/null @@ -1,16 +0,0 @@ -# 3-1.シンプルな編集の場合 - -原文はこちら：[setup](https://github.com/mdn/content#setup) -こちらも参考に：[MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) - -#### 誤植や軽微な単語の修正などの、シンプルな編集の場合、GitHub上で直接該当のファイルに行き、ペンシルボタンから編集を行います。（それ以外の普通に翻訳作業をする場合は、次のページに進んでください） -#### ペンシルボタンから編集を行うと、fork した自分のリポジトリに自動で新しいブランチが作られます。 - -- https://github.com/mdn/translated-content リポジトリに行きます。 -- 編集をしたい該当のファイルまで行きます。 -- 例： - - 既に翻訳されているページ（HTML 属性: readonly）の誤字をみつけたとします - - 該当のファイル：https://github.com/mdn/translated-content/blob/main/files/ja/web/html/attributes/readonly/index.html に行きます -- 右上のペンシルボタン（編集ボタン）を押して編集します -- 「Propose changes」にコミットメッセージを記載して［Propose changes］ボタンを押します。 -- Pull Request を作成します diff --git a/supplement.md b/supplement.md deleted file mode 100644 index a51051b..0000000 --- a/supplement.md +++ /dev/null @@ -1,18 +0,0 @@ -# 翻訳の流れ（補足） -## GitHub Issueの利用 〜個人の作業、でもコミュニティーの作業でもある〜 - -### 目的＆メリット -1. 作業の重複/衝突防止 -1. 他人の目からも状況を把握可能 -1. 助けを求めることもできる -1. 自分の貢献の履歴を振り返ることができる(MDNのダッシュボードよりもひろい意味で) -1. 似た質問に実例を引いて回答できる - - -### 実例（左と対応してません） -- [#183](https://github.com/mozilla-japan/translation/issues/183)　翻訳の宣言→作業→終了 -- [#235](https://github.com/mozilla-japan/translation/issues/235) 編集レビューの宣言→終了 -- [#201](https://github.com/mozilla-japan/translation/issues/201) 助けを求める→作業者の交代 -- [#220](https://github.com/mozilla-japan/translation/issues/220) 関連するドキュメントを宣言→　　　進捗に応じて☑を付けていく - -#### ※ 投稿は slack の [#translation チャンネル](https://mozillajp.slack.com/messages/C5N6SFQMP/)に流れる diff --git a/synchronize-forked-repository.md b/synchronize-forked-repository.md deleted file mode 100644 index be5ef20..0000000 --- a/synchronize-forked-repository.md +++ /dev/null @@ -1,33 +0,0 @@ -# 3-4.fork元のリポジトリと同期する - -原文はこちら：[setup](https://github.com/mdn/content#setup) -こちらも参考に：[MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) - -## 翻訳した内容についても、他の人からの更新を取り込みます。 - -#### ※2回目以降の翻訳や、forkしてから時間がたった場合、以下のようにして fork したリポジトリを最新の状態にしてください。 -#### こちらもウェブ上でできます。自分のtrnaslated-contentリポジトリのページにある「Fetch upstream」ドロップダウンを押すと表示される「Fetch and merge」ボタンを押してください。 -##### 前提：fork元のリポジトリをリモート参照先として追加してあること： (git remote -v で確認できる) -``` -# forkしたリポジトリをチェックアウトしたディレクトリに移動 -$ cd ~/repos/mdn/trnaslated-content - -# リモート参照先として fork元のリポジトリを transmdn という名前で追加 -$ git remote add transmdn git@github.com:mdn/translated-content.git - -# forkしたリポジトリをチェックアウトしたディレクトリに移動 -$ cd ~/repos/mdn/translated-content - -# 手元の作業コピーを main ブランチに切り替える（チェックアウト） -$ git checkout main - -# 手元の作業コピーに、fork 元の main の最新を取り込む -$ git pull transmdn main - -# 自分の作業ブランチに切り替える（チェックアウト。なければ作成される。※my-workは任意のブランチ名） -$ git checkout -b my-work - -# 最新にした main を作業ブランチに merge -$ git merge main -``` -その後、作業をすすめて push -> pull request します。 diff --git a/time-schedule.md b/time-schedule.md deleted file mode 100644 index d106d2f..0000000 --- a/time-schedule.md +++ /dev/null @@ -1,14 +0,0 @@ - -# 翻訳イベントのタイムスケジュール - - -| 時間 | テーマ| -| :---- | :---- | -| 12:30 | 開場| -| 13:00 | 流れ集合、導入説明(必要な方)、各自作業開始 | -| 15:00頃 | 中間報告会・相談会・自己紹介・休憩 | -| 17:00 | 成果発表、感想の共有 | -| ~18:00 | 終了 | - - -※開催日によって、時刻が変わることあり diff --git a/translation-flow.md b/translation-flow.md deleted file mode 100644 index 0778eff..0000000 --- a/translation-flow.md +++ /dev/null @@ -1,4 +0,0 @@ -# 翻訳の流れ - -こちらも参考に： -[MDN Web Docs ドキュメント翻訳の始め方](https://github.com/mozilla-japan/translation/wiki/Get-started-with-translation-of-Mozilla-documentations) diff --git a/translation-introduction.md b/translation-introduction.md deleted file mode 100644 index 7e84ca1..0000000 --- a/translation-introduction.md +++ /dev/null @@ -1,13 +0,0 @@ -# 導入 - -### Mozilla Community Slackに参加 -- こちらで情報のやり取りや進捗の管理、質問など現場のコミュニケーションを行っています。差し支えなければご参加ください。 -- [slack 参加リンクはこちら](https://join.slack.com/t/mozillajp/shared_invite/enQtMjI2NDMwODUwNzY5LTAyZmQ4NTY3MWYzZDA4MDRhYjlhNDA4MzI1M2ZjNGVhMjc2N2VhZjkwMzI2YWNjZDI4ZDU4Zjk5OTVlYWI1NTM) -- 登録名はハンドルネームで結構です -- 参加後、 #translation チャンネルにご参加ください - -### GitHub アカウントを作成　 -- 記事を翻訳するのに、[GitHub](https://github.com/)のアカウントが必要になります。 -- 2020年末よりMDNのシステム移行（Yari）で翻訳にGitHubを使用することになりました。そのためGitHubのアカウントが無い場合は作成する必要があります。 -GitHub アカウントを持っていない方はぜひ同時に作成してみてください！ -- 既にGitHubアカウントをお持ちの方はサインインして作業ができます。 diff --git a/translation/0_preparation.md b/translation/0_preparation.md new file mode 100644 index 0000000..2982ac3 --- /dev/null +++ b/translation/0_preparation.md @@ -0,0 +1,17 @@ +# 0. 準備するもの + +## GitHub アカウントの用意 {#github} + +- 翻訳作業を行うのに、[GitHub](https://github.com/) のアカウントが必要になります。 +- 2020年末より、MDN のシステムが Kuma から Yari に移行したことに伴い、全ての記事の管理に GitHub を使用することになりました。 +- そのため GitHub アカウントをお持ちでない場合は作成する必要があります。GitHub アカウントを持っていない方はぜひ作成してみてください！ +- 既に GitHub アカウントをお持ちの方はサインインして作業ができます。 + +## Node.js / Yarn のインストール {#yarn} + +- 手元のブラウザで翻訳作業中の内容をローカルプレビューするために、Yarn が実行できる環境が必要になります。 +- まずは Node.js がインストールされている必要があります。 + - Node.js のインストールは nodenv を使うなど様々な方法があります。 + - ご自身に合った方法でインストールを行ってみてください。分からなければ Slack でお気軽にご質問ください。 +- Node.js がインストールできていれば、次のページを参考に Yarn をインストールしてください。 + - https://yarnpkg.com/getting-started/install diff --git a/translation/1_choose-article.md b/translation/1_choose-article.md new file mode 100644 index 0000000..47068eb --- /dev/null +++ b/translation/1_choose-article.md @@ -0,0 +1,24 @@ +# 1. 記事を選定する + +## 翻訳・修正したい記事がある場合 {#exist} + +- [MDN Web Docs](https://developer.mozilla.org/ja/) を見ていると誤字脱字や、日本語翻訳されていない記事を見つけることがあります。 +- ご自身の関心がある記事がそのような状態であれば、その記事を対象に作業するとよいでしょう。 + +## 翻訳されていない記事を見つける {#find} + +- 2022年3月に MDN Web Docs サイトのデザインが一新された関係で、MDN Web Docs 内では未翻訳の記事を見つけることが困難になってしまいました。 +- 翻訳コミュニティ内で作成された非公式の「[MDN翻訳ステータス一覧表](https://mdn.lavoscore.org/)」ページが存在しています。 +- 翻訳作業を始める初心者の方にお勧めなのは、記事の文章量が比較的少ない「用語集」ページです。 + - 「[用語集ページのうち日本語版が存在しない記事一覧](https://mdn.lavoscore.org/?regex_b=glossary&sort=size-asc&filter=not-ja)」を見つけることができます。 + +## GitHub Issues から未着手の Issue を見つける {#issues} + +- MDN 日本語翻訳に関する Issue を取り扱うための GitHub リポジトリが存在しています。 + - https://github.com/mozilla-japan/translation/issues/ +- このリポジトリの Issues には、これまでに登録された Issue があり、中には未着手のものや翻訳作業をリクエストする Issue が存在しています。 +- 未着手のものがあれば、それを対応するのもよいでしょう。対応する場合は他の人と作業が被らないように、Issue にコメントを残したり Assignee をご自身に変更したりしてください。 + +## その他 {#other} + +- [Mozilla Japan コミュニティの Wiki](https://github.com/mozilla-japan/translation/wiki#%E9%96%8B%E7%99%BA%E8%80%85%E5%90%91%E3%81%91%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88-mdn-%E3%81%AE%E7%BF%BB%E8%A8%B3) にも記事選定のための情報があります。 diff --git a/translation/2_declare-task.md b/translation/2_declare-task.md new file mode 100644 index 0000000..7cf3925 --- /dev/null +++ b/translation/2_declare-task.md @@ -0,0 +1,18 @@ +# 2. 作業を宣言する + +## GitHub に Issue を作成する {#github} + +- 翻訳コミュニティでは、日本語翻訳作業用の GitHub リポジトリを用意しています。 + - https://github.com/mozilla-japan/translation/issues/ +- 翻訳作業に関するタスクは、このリポジトリの Issues に記録しています。 +- 翻訳作業の対象ページが決まったら、作業内容を書いた Issue を作成してください。 + - この Issue は、日本語翻訳コミュニティ専用なので日本語で記述して構いません。フォーマットもそれほど厳密でなくて構いません。 + - 後述しますが、翻訳記事リポジトリの Pull-Request を作成する場合も、レビュアーは日本語翻訳コミュニティのメンバーなので日本語で記述して構いません。 + - 結果的に、MDN の翻訳作業において GitHub 上で（グローバライゼーションを意識して）全て英文で Issue 等を記述する必要はありません。 + +## 月例ミートアップ時の作業報告 {#docs} + +- 月例ミートアップ中は、更に「イベント当日の情報交換用掲示板」へ書き込みを行ってください。 + - https://docs.google.com/document/d/16cKB9t8Deiv0emx01jvy1TJPIFQrqd-EUxZMRUvhlj0/edit +- この書き方については、月例ミートアップの案内で説明します。 +- 月例ミートアップ外の時間帯に作業する場合は、ここに書き込む必要はありません。GitHub Issue のみで作業してください。 diff --git a/translation/3_fork-repository.md b/translation/3_fork-repository.md new file mode 100644 index 0000000..7c6ec84 --- /dev/null +++ b/translation/3_fork-repository.md @@ -0,0 +1,51 @@ +# 3. fork リポジトリを用意する + +## 初めてリポジトリを fork する場合 {#first} + +- https://github.com/mdn/content リポジトリを fork します。 +- https://github.com/mdn/translated-content リポジトリを fork します。 +- 以上で完了です。 + +## 既にリポジトリを fork している場合 {#already} + +- fork したリポジトリ https://github.com/YOUR_NAME/content のページへアクセスします。 +- 画面上部にある「Sync fork」を押して「Update branch」を実行します。 +- "This branch is up to date with mdn/content:main." と表示されたことを確認します。 + - ここが異なる表示結果になった場合、リポジトリに不整合が生じている可能性があります。その場合は以下の Git コマンドを参考に問題を解決するか Slack で相談してください。 +- https://github.com/YOUR_NAME/translated-content のページでも同様のことを行います。 + +### 補足：Git コマンドで Sync fork する方法 {#command} + +``` +// 前提：clone したリポジトリのディレクトリに移動している +[~] $ cd ~/path/to/mdn_repos/ +[mdn_repos] $ git clone git@github.com:YOUR_NAME/translated-content.git +[mdn_repos] $ cd ~/path/to/mdn_repos/translated-content + +// main ブランチにいることを確認する +[translated-content] $ git branch + +// main ブランチにいなければ、main ブランチに移動する +[translated-content] $ git checkout main + +// origin のみであることを確認する +[translated-content] $ git remote -v +origin git@github.com:YOUR_NAME/translated-content.git (fetch) +origin git@github.com:YOUR_NAME/translated-content.git (push) + +// remote を追加する +[translated-content] $ git remote add upstream git@github.com:mdn/translated-content.git + +// upstream が増えていることを確認する +[translated-content] $ git remote -v +origin git@github.com:YOUR_NAME/translated-content.git (fetch) +origin git@github.com:YOUR_NAME/translated-content.git (push) +upstream git@github.com:mdn/translated-content.git (fetch) +upstream git@github.com:mdn/translated-content.git (push) + +// upstream からローカルブランチに変更を取り込む +[translated-content] $ git pull upstream main + +// ローカルブランチの状態を GitHub に反映させる +[translated-content] $ git push origin main +``` diff --git a/translation/4_clone-repository.md b/translation/4_clone-repository.md new file mode 100644 index 0000000..a9e9e7a --- /dev/null +++ b/translation/4_clone-repository.md @@ -0,0 +1,46 @@ +# 4. fork リポジトリを clone する + +## 初めてリポジトリを clone する場合 {#first} + +``` +// 作業用ディレクトリを作成する +[~] $ cd ~/path/to +[~/path/to] $ mkdir mdn_repos +[~/path/to] $ cd ~/path/to/mdn_repos + +// fork リポジトリを 2 つとも clone する +[mdn_repos] $ git clone git@github.com:YOUR_NAME/content.git +[mdn_repos] $ git clone git@github.com:YOUR_NAME/translated-content.git + +[mdn_repos] $ ls +content translated-content + +// content ディレクトリ内に .env を作成する +[mdn_repos] $ cd content +[content] $ echo 'CONTENT_TRANSLATED_ROOT=../translated-content/files' > .env +[content] $ cat .env +CONTENT_TRANSLATED_ROOT=../translated-content/files + +// ローカルプレビューができるように yarn install しておく +[content] $ yarn install +``` + +## 既にリポジトリを clone している場合 {#already} + +``` +// 作業用ディレクトリに移動する +[~] $ cd ~/path/to/mdn_repos + +// 最新の fork リポジトリを pull する +[mdn_repos] $ cd content +[content] $ git checkout main +[content] $ git pull + +// content リポジトリでは yarn install し直しておく +[content] $ yarn install + +// translated-content リポジトリも pull しておく +[content] $ cd ../translated-content +[translated-content] $ git checkout main +[translated-content] $ git pull +``` diff --git a/translation/5_new-ja-file.md b/translation/5_new-ja-file.md new file mode 100644 index 0000000..3b44af5 --- /dev/null +++ b/translation/5_new-ja-file.md @@ -0,0 +1,65 @@ +# 5. 日本語記事ページを新規作成する + +## 既に日本語記事が存在する場合（編集の場合） {#edit} + +- このページで行うことはありません。次のページへスキップしてください。 + +## 新たに新規ページを翻訳する場合（新規作成の場合） {#new} + +- 例えば https://developer.mozilla.org/en-US/docs/Glossary/Entity の日本語版が存在しないとします。 +- 新たに https://developer.mozilla.org/ja/docs/Glossary/Entity のページを作る手順は以下の通りです。 + +``` +// translated-content ディレクトリへ移動する +[~] $ cd ~/path/to/mdn_repos/translated-content + +// main ブランチにいることを確認する +[translated-content] $ git branch + +// ls しながら、URL に対応するディレクトリへ移動する +[translated-content] $ ls +[translated-content] $ cd files/ja +[ja] $ ls +[ja] $ cd glossary + +// glossary ディレクトリ内に entity ディレクトリを新規作成する +[glossary] $ mkdir entity +[glossary] $ cd entity + +// 英語版のページファイル index.md をここにコピーする +[entity] $ cp ~/path/to/mdn_repos/content/files/en-us/glossary/entity/index.md . +``` + +- ターミナルで別タブを開きます。 + +``` +// content ディレクトリに移動する +[~] $ cd ~/path/to/mdn_repos/content + +// ローカルプレビューを起動する +[content] $ yarn start +``` + +- ブラウザから http://localhost:5042/ja/docs/Glossary/Entity を開きます。 + - ja の URL で存在しなかったはずのページが表示できていることを確認できたら OK です。 + - 実際にはページが存在しているのに、初回アクセス時に Page not found となる場合があります。その場合はブラウザでページをリロードすれば表示されます。 +- cp コマンドを打っていた元のターミナルのタブに戻ります。 + +``` +// 一度、この状態で translated-content リポジトリをコミットする + +// トピックブランチを切る（ブランチ名は GitHub Issue の番号にでもしておく） +// ※トピックブランチ名に特に決まりはありません。自由に決めてください。 +[entity] $ git checkout -b issue-123 + +// ブランチが移動しているか確認する +[entity] $ git branch + +// コミットする +// ※コミットメッセージも特に決まりはありません。自由に決めてください。 +[entity] $ git add . +[entity] $ git status +[entity] $ git commit -m "copied index.md from en-us" +``` + +- ここまでできたら、記事を編集する場合と同じ手順で作業を進めます。 diff --git a/translation/6_edit-ja-file.md b/translation/6_edit-ja-file.md new file mode 100644 index 0000000..98dc2a3 --- /dev/null +++ b/translation/6_edit-ja-file.md @@ -0,0 +1,93 @@ +# 6. 日本語記事ページを編集する + +## 5. の手順をスキップした場合（編集の場合） {#local-preview} + +- 例えば https://developer.mozilla.org/ja/docs/Glossary/Entity を編集する手順は以下の通りです。 + +``` +// translated-content ディレクトリへ移動する +[~] $ cd ~/path/to/mdn_repos/translated-content + +// main ブランチにいることを確認する +[translated-content] $ git branch + +// ls しながら、URL に対応するディレクトリへ移動する +[translated-content] $ ls +[translated-content] $ cd files/ja +[ja] $ ls +[ja] $ cd glossary/entity + +// トピックブランチを切る（ブランチ名は GitHub Issue の番号にでもしておく） +// ※トピックブランチ名に特に決まりはありません。自由に決めてください。 +[entity] $ git checkout -b issue-123 +``` + +- ターミナルで別タブを開きます。 + +``` +// content ディレクトリに移動する +[~] $ cd ~/path/to/mdn_repos/content + +// ローカルプレビューを起動する +[content] $ yarn start +``` + +- ブラウザから http://localhost:5042/ja/docs/Glossary/Entity を開きます。 + - ja の URL でページが表示できていることを確認できたら OK です。 + - 実際にはページが存在しているのに、初回アクセス時に Page not found となる場合があります。その場合はブラウザでページをリロードすれば表示されます。 + +## 共通の手順（編集または新規作成） {#edit-flow} + +### メタデータ部分（Front-matter）の編集 {#front-matter} + +- index.md ファイルは、Markdown によるコンテンツの記述部分より手前に、Yaml によるメタデータの記述があります。 + - そのメタデータ部分は Front-matter と呼ばれます。これは MDN に限らず一般的に用いられている記法の一つです。 +- MDN では、翻訳ファイル側の Front-matter を特定のフォーマットにする必要があります。 + - そのフォーマットは英語版と異なります。そのため、作業者が編集する必要があります。 + - これは「[ja - フロントマターから不要なメタデータを削除](https://github.com/mdn/translated-content/issues/7858)」による要請です。 +- 英語版が次のようになっていたとします。 + +```yaml +--- +title: Entity +slug: Glossary/Entity +tags: + - CodingScripting + - Composing + - HTML +--- +``` + +- 日本語版では、`title` と `slug` 以外を削除し、`l10n` を追加します。 + - `tags`, `translation_of`, `browser-compat`, `spec-urls` などは全て削除してください。 + - `l10n` は「エル 10 エヌ」です。アイではありません。 + +```yaml +--- +title: Entity +slug: Glossary/Entity +l10n: + sourceCommit: 1cfa0cd49bb572480f014af3b15dee3bda974178 +--- +``` + +- `sourceCommit` のハッシュ値は、編集作業時点の content リポジトリの当該記事ページのファイル（英語版）の最新コミットハッシュ値（`git log` で確認できる）を記述します。 + - これにより、日本語版が英語版のいつのバージョンに追従しているかを把握することができるようになります。 + - つまり、これを記述する場合は、日本語版の記事の内容を英語版の最新の内容と同期させる必要があります。 + - 軽微な修正のみを行いたい場合で、`l10n` が記述されていない場合には上記の Front-matter の編集はしなくても構いません。 +- 実際の参考PR：https://github.com/mdn/translated-content/pull/8025 + +### 本文部分（Markdown）の編集 {#body} + +- 英語文を日本語文に翻訳していきます。 +- その際、「英数字の前後には半角スペースを挿入する（例えば OK のように）」や、「-er、-or、-ar、-cy、-ry、-gy、-xy で終わる単語はすべて長音を付加する（ユーザーなど）」といった表記ルールを守る必要があります。 +- 詳しくは以下のガイドラインを参照してください。 + - [表記ガイドライン](https://github.com/mozilla-japan/translation/wiki/Editorial-Guideline) + - [L10N ガイドライン](https://github.com/mozilla-japan/translation/wiki/L10N-Guideline) + - [Mozilla 用語集](https://github.com/mozilla-japan/translation/wiki/Mozilla-L10N-Glossary) + - [日本語の文体](https://docs.google.com/spreadsheets/d/1y-hC-xMXawCgcYZwJDnvuSlAOTgMRLLyqXurpYkJbYE/edit#gid=0) +- 記事中にある別の MDN ページへのリンク URL も英語版から日本語版へ変更します。 + - このとき、別の MDN ページの日本語版が存在していなくても、URL は日本語版のものに書き換えてください。 + - MDN では翻訳ページ URL に翻訳記事が存在しない場合、自動で英語版記事へリダイレクトするような設定がされています。 + - URL を日本語版のものに書き換えておけば、後々その記事が日本語化されたときにリンクが正常に機能するようになります。 +- 翻訳作業（編集作業）が終わったら、次の手順へ進みます。 diff --git a/translation/7_create-pull-request.md b/translation/7_create-pull-request.md new file mode 100644 index 0000000..79ca2a6 --- /dev/null +++ b/translation/7_create-pull-request.md @@ -0,0 +1,13 @@ +# 7. Pull Request を作成する + +- 翻訳作業（編集作業）が完了してコミットしたら、トピックブランチを push します。 +- https://github.com/mdn/translated-content へアクセスすると、"Compare & pull request" ボタンが表示されているはずなのでこれを押して Pull Request を作成します。 + - レビュアーは自動で設定されます。 + - Pull Request の記述フォーマットはそれほど厳密でなくても構いません。 + - [過去の Pull Request](https://github.com/mdn/translated-content/pulls?q=is%3Apr+is%3Aclosed+label%3Al10n-ja+) の記述例を参考にしてみてください。 +- もしも月例ミートアップ中にここまで進んだ場合は、「イベント当日の情報交換用掲示板」の書き込みを「レビュー待ち」の欄に移動してください。 + - https://docs.google.com/document/d/16cKB9t8Deiv0emx01jvy1TJPIFQrqd-EUxZMRUvhlj0/edit +- レビュアーから差し戻しがあった場合は対応をお願いします。別用などで対応ができない場合にはその旨をコメントしてください。別の人が引き継げるようになります。 +- レビューが通ってマージされた場合は、ステップ 2. で作成した宣言用の Issue をクローズします。 + - https://github.com/mozilla-japan/translation/issues/ +- 以上で翻訳作業は完了です！お疲れさまでした！ diff --git a/translation/index.md b/translation/index.md new file mode 100644 index 0000000..225ec18 --- /dev/null +++ b/translation/index.md @@ -0,0 +1,15 @@ +# 翻訳作業の流れ + +- MDN Web Docs には、「[英語版（原語版）の記事](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a)」と「[日本語版の記事](https://developer.mozilla.org/ja/docs/Web/HTML/Element/a)」があります。 + - 中国語や韓国語など他の言語もあります。英語版以外の記事は「翻訳記事」と呼ばれます。 + - 翻訳記事は、英語版を翻訳することで作成します。 + - 英語版がなく翻訳版だけ存在するような記事は原則ありません。 + - しかし英語版の URL が移動したり削除されたりすることによって、翻訳記事が「孤立」することがあります。こうした記事は Orphaned （孤立記事）としてマーク付けされます。 +- このコミュニティにおける翻訳作業では、主に次のような対応を行います。 + - 「日本語版が存在しない記事」を翻訳して作成する。 + - 「日本語版が存在するが、内容が英語版と異なっている記事」の内容を英語版に追従する。 + - 日本語版作成後に、英語版がアップデートされていることがしばしばあります。 + - 「日本語版が存在するが、未翻訳、誤訳、誤字脱字がある記事」の修正を行う。 + - 「英語版に修正すべき箇所が見つかった記事」があれば、英語版の修正を行う。 + - その他、MDN Web Docs 内の修正すべき箇所が見つかった記事、部分について、修正を行う。 +- それでは、翻訳作業を始めてみましょう。