（非公式） Dfinity ドキュメント翻訳プロジェクト

翻訳手順

翻訳の状況は、翻訳の概要と進捗状況の issues を確認してください。

手順 1: 翻訳を始める準備の準備

Dfinity のドキュメントは AsciiDoc によって書かれており、Antora を用いてビルドされています。ローカル環境でドキュメントをビルドして確認できるように、以下の手順で Antora をインストールします。

Antora のインストールには Node が必要です。

Windows 10 の場合には WSL2 上にインストールすることをお勧めします。

Mac OS の場合には Homebrew でインストールするのが良いと思います。

Node のインストールができたら、Antora のインストールを行います。ここではグローバル環境にインストールする手順を説明します。

$ npm i -g @antora/cli@2.3 @antora/site-generator-default@2.3

以下のコマンドでインストールできていることを確認します。

$ antora -v

2.3.x などのバージョン名が表示されれば OK です。

手順 2: 翻訳を始める準備

まずは、このリポジトリを右上から Fork してください。

そして、リポジトリをクローンします。your には、あなたの GitHub のユーザーネームを入れてください。

$ git clone https://github.com/your/docs
$ cd docs

翻訳作業を行うためのブランチを作成します。どのファイルを翻訳するかは、翻訳の概要と進捗状況の翻訳ページ一覧を確認して、翻訳したい箇所をコメントしてください。

ここでは、例として introduction/pages/welcome.adoc を翻訳するためのブランチを作成します。

$ git checkout -b introduction/pages/welcome.adoc

これで、翻訳を始める準備は完了です。エディタを使って、翻訳箇所のファイルを編集します。

手順 3: 翻訳

スタイルガイドに目を通してください。わからないことがあれば Discord の#ドキュメント翻訳チャネルで質問してください。

エディタとしては VSCode を推奨します。 AsciiDoc の拡張機能を入れると少し幸せになれるかもしれません。

手順 4: 翻訳内容の確認

翻訳した文章を確認するために、手順 1 で導入した Antora を用いてローカルビルドします。

$ antora local-antora-playbook.yml

のコマンドを叩くと、ビルドが実行されます。ビルド後、build/site/docs 以下の html ファイルを直接開きます。

$ open build/site/docs/introduction/welcome.html

ブラウザが開き、翻訳が反映されていることが確認できます。

手順 5: 翻訳内容のプルリクを出す

翻訳が終わったら、ローカルリポジトリにコミットしたあと、自分のリモートリポジトリにプッシュします。コミットが複数になった場合、なるべく１つのコミットにまとめていただければありがたいですが、難しければそのままでも OK です。

$ git add modules/introduction/pages/welcome.adoc
$ git commit -m "translated: introduction/pages/welcome.adoc"
$ git push origin introduction/pages/welcome.adoc

最後に、Github からプルリクを出します。このとき、出し先が Japan-DfinityInfoHub/docs になるようにします。間違えて本家の dfinity/docs に出してしまわないように気をつけてください。

以上です！メンテナーがレビューをして問題なければマージされます。

Contributors ✨

Special thanks to these wonderful people (emoji key):

_hoosan

_tokuryoo

_gelgoog999

_pontagon333

Write code for the Internet Computer

You can get started right away by downloading the Internet Computer Software Development Kit (SDK) and cloning an existing sample project or by exploring the documentation. Check out the links below to begin building smart contract canisters to run on the Internet Computer:

Get the SDK Download the SDK for the Internet Computer.
Quick Start Deploy your first app on the Internet Computer.
Examples Repository Explore on your own in the examples repository.
Language Guide Explore the Motoko programming language.
Videos Watch the Building Applications for the Internet Computer: Fundamentals video series.

Contributing to the documentation

The Internet Computer blockchain is removing the limitations from smart contract software with a network that scales its capacity with demand and serves interactive web content directly to end users. If you are interested in learning more about the project, you can connect with other developers in the community through the Developer Forum and follow us on social media for information about upcoming events and new developments.

If you would like to contribute to the documentation, see our CONTRIBUTING and CODE OF CONDUCT to get started.

Updating the Site Navigation

To update the left-side site navigation, make changes to nav.adoc.

Testing your changes locally

To test your changes locally, clone the [dfinity-docs-playbook] https://github.com/dfinity/dfinity-docs-playbook and follow the installation instructions. Push the changes you want to preview up to a branch on GitHub. You will need to modify the antora-playbook.yml to point to your branch, which will look something like

content:
  sources:
    # Remote repositories and branches
    - url: git@github.com:dfinity/docs.git
      branches: "your-branch-name"

Note: the URL may be different if you are working from a fork

Then, run npm run build to compile the documentation.

You will then need to open the static directory in your browser with a simple static file server to preview your changes.

Note - the root page of the site automatically redirects to https://smartcontracts.org, so you will need to skip past the index to another page. For example, http://127.0.0.1:5500/build/site/docs/quickstart/local-quickstart.html.

numtet / docs