新しい Vue.js ドキュメントの翻訳について

[kazupon]

@jay-es @naokie @kiaking

Vue.js公式ブログのアナウンスでもありましたが、2/7 に npm でインストール可能な Vue.js のメインストリームがいよいよ Vue 3 に切り替わります。
それに伴い、Vue.js 公式ドキュメントも staging.vuejs.org でホストされているものが、vuejs.org に変わる予定です。

staging.vuejs.org でホストされているドキュメントは、v3.vuejs.orgをベースにre-fineされたものですが、Evan 氏によってほぼ全面書き換えられています。
ですので、既存のv3.vuejs.orgから流用しながらの翻訳は今回は厳しそうです。(もしかしたら、理由用できるものがあるかも)
一から翻訳した方がよいと考えています。

ドキュメントの構成

新しいドキュメントの構成ですが、ディレクトリ構成は以下のようになっています。
https://github.com/vuejs/docs/tree/main/src

新しいドキュメントは VitePress で markdown がビルドされホストされます。

以下は staging.vuejs.org に表示されるナビゲーション部分をキャプチャしたものです。

VitePress で構築されるドキュメントは、v3.vuejs.org のときと同じく、メニューとディレクトリで構成されています。
そして、ディレクトリには、章単位で makrdown ファイルが存在する形となっています。

翻訳方法

翻訳ですが、これまでの Vue.js ドキュメント翻訳でやってきたやり方でやるといいと思っています。
ナビゲーションのメニュー単位でディレクトリがあり、その中に makrdown ファイルがあるので、1 markdown を一人が翻訳するという形です。

翻訳状況の管理方法

翻訳状況の管理については、GitHub issues を使うとよいでしょう。
ナビゲーションのメニュー単位、つまりディレクトリ単位 (e.g. メニュー: ガイド、ディレクトリ src/guide) で issue を作り、その issue に メニューに対応するディレクトリにある markdown ファイルですべてチェックボックス付きでリスト化します。

そして、1人 1 markdown ファイルを翻訳作業できるように、章タイトル名付きで GitHub issue 化します。
その issue 化したものを管理できるように、issue 番号で対象となるメニューの issue に紐付けます。

markdown ファイルですべてチェックボックスによるリスト化、そして 1 markdown 1 issue については、 @naokie さんが対応されたこちらが参考になります。
vuejs-jp/ja.vuejs.org#347

翻訳者募集方法

v3.vuejs.org の翻訳と同じく、vue.js-jp の slack アナウンスして募集します。
また、翻訳開始したら、vuejs-jp の Twitter アカウントでもアナウンスします。

翻訳途中の本家ドキュメントのアップデートの差分

@kiaking さんが作った ryo-cho を使って GitHub Actions によって差分を issue 化します。

ホスト先

vue.js が持っている netlify を使ってホストします。
ドメインの割当は、Evan 氏もしくは、Ben 氏に対応して貰う予定です。

参考

すでに中国の方では、翻訳が進んでいます。
https://github.com/vuejs-translations/docs-zh-cn

[kazupon]

@jay-es @naokie @kiaking
こんな感じですが、どうでしょう？
私の方で、翻訳方針について書きましたが、何かいいアイデア、もっとこうした方がいいよ！っていうのがありました、コメントください。 🙏

[jay-es]

@kazupon タグのリネーム完了しました。
たしかに README.md は原文をほぼそのまま翻訳しただけなので、参加者向けの内容にした方がよさそうですね。
後ほど PR 作成してみます。

[jay-es]

PR 作成しました #276
CONTRIBUTING.md への導線を追加し、翻訳と関係ない内容についてはコメントアウトしました

[kazupon]

@jay-es PRマージしましたが、明日は休日ですので、24日木曜日にアナウンスしますね。🙂

[jay-es]

了解です！ よろしくお願いします:pray:

[jay-es]

PR 承認後そのままマージされてしまうかもしれないので、2 人分の承認がないとマージできないよう設定しておきました。
問題ありそうなら戻します！