本リポジトリは、こちらで実施している Dfinity ドキュメント翻訳プロジェクトの子リポジトリです。
Dfinity 公式ドキュメントは、dfinity/docs のリポジトリに全てのドキュメントファイルが集約されているわけではなく、dfinity/motoko などの他のリポジトリに置かれた AsciiDoc ファイルが集約されて一つのドキュメントとなっています。
本リポジトリでは、dfinity/motoko のドキュメントを翻訳しています。
翻訳の状況は、親リポジトリである Japan-DfinityInfoHub/docs の翻訳の概要と進捗状況の issues を確認してください。
Japan-DfinityInfoHub/docs の手順 1 と同じです。 既に実施している方は飛ばしてください。
Dfinity のドキュメントは AsciiDoc によって書かれており、Antora を用いてビルドされています。 ローカル環境でドキュメントをビルドして確認できるように、以下の手順で Antora をインストールします。
Antora のインストールには Node が必要です。
Windows 10 の場合には WSL2 上にインストールすることをお勧めします。
Mac OS の場合には Homebrew でインストールするのが良いと思います。
Node のインストールができたら、Antora のインストールを行います。 ここではグローバル環境にインストールする手順を説明します。
$ npm i -g @antora/[email protected] @antora/[email protected]
以下のコマンドでインストールできていることを確認します。
$ antora -v
2.3.x などのバージョン名が表示されれば OK です。
まずは、このリポジトリを右上から Fork してください。
そして、リポジトリをクローンします。your には、あなたの GitHub のユーザーネームを入れてください。
$ git clone https://github.com/your/motoko
$ cd motoko
翻訳作業を行うためのブランチを作成します。 どのファイルを翻訳するかは、Japan-DfinityInfoHub/docs の翻訳の概要と進捗状況の翻訳ページ一覧を確認して、翻訳したい箇所をコメントしてください。
ここでは、例として language-guide/pages/motoko.adoc を翻訳するためのブランチを作成します。
$ git checkout -b language-guide/pages/motoko.adoc
これで、翻訳を始める準備は完了です。エディタを使って、翻訳箇所のファイルを編集します。
今回の例の場合、ファイルの場所は、./doc/modules/ に、上で示した language-guide/pages/motoko.adoc を足した、./doc/modules/language-guide/pages/motoko.adoc です。
スタイルガイドに目を通してください。 わからないことがあれば Discord の#ドキュメント翻訳チャネルで質問してください。
エディタとしては VSCode を推奨します。 AsciiDoc の拡張機能を入れると少し幸せになれるかもしれません。
翻訳した文章を確認するために、手順 1 で導入した Antora を用いてローカルビルドします。
$ antora local-antora-playbook.yml
のコマンドを叩くと、ビルドが実行されます。
ビルド後、build/site/docs 以下の html ファイルを直接開きます。
$ open build/site/docs/introduction/welcome.html
ブラウザが開き、翻訳が反映されていることが確認できます。
翻訳が終わったら、ローカルリポジトリにコミットしたあと、自分のリモートリポジトリにプッシュします。 コミットが複数になった場合、なるべく１つのコミットにまとめていただければありがたいですが、難しければそのままでも OK です。
$ git add doc/modules/language-guide/pages/motoko.adoc
$ git commit -m "translated: language-guide/pages/motoko.adoc"
$ git push origin language-guide/pages/motoko.adoc
最後に、Github からプルリクを出します。 このとき、出し先が Japan-DfinityInfoHub/motoko になるようにします。 間違えて本家の dfinity/motoko に出してしまわないように気をつけてください。
以上です！メンテナーがレビューをして問題なければマージされます。
A simple language for writing Internet Computer (IC) actors.
- Building, installing, developing on Motoko.
- Overview slides.
- Small samples.
- Language manual and general documentation
- Concrete syntax
-
High-level language for programming IC applications
-
Simple ("K.I.S.S.") design and familiar syntax for average programmers
-
Good and convenient support for actor model
-
Good fit for underlying Wasm and IC execution model
-
Anticipate future extensions to Wasm where possible
-
Simple class-based OO language, objects as closures
-
Classes can be actors
-
Async construct for direct-style programming of asynchronous messaging
-
Structurally typed with simple generics and subtyping
-
Overflow-checked number types, explicit conversions
-
JavaScript/TypeScript-style syntax but without the JavaScript madness
-
Inspirations from Java, C#, JavaScript, Swift, Pony, ML, Haskell