Giter Site home page Giter Site logo

nilnu1l / docs Goto Github PK

View Code? Open in Web Editor NEW

This project forked from japan-dfinityinfohub/docs

0.0 0.0 0.0 16.9 MB

(Unofficial) Japanese translation of Dfinity documentation : (非公式) Dfinity ドキュメントの日本語翻訳

Home Page: https://nifty-beaver-611cb8.netlify.app/docs/introduction/welcome.html

License: Other

Modelica 83.04% JavaScript 15.47% CSS 1.50%

docs's Introduction

All Contributors

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

翻訳手順

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

手順 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 です。

手順 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: 翻訳内容のプルリクを出す

翻訳が終わったら、ローカルリポジトリにコミットしたあと、自分のリモートリポジトリにプッシュします。 なるべく1つのコミットにまとめていただければありがたいですが、難しければそのままでも 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

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.

docs's People

Contributors

alexabsmith avatar allcontributors[bot] avatar andreacerulli avatar andrewwylde avatar anthonymq avatar bingyy avatar bogwar avatar brson avatar carstenjacobsen avatar crusso avatar derlerd-dfinity avatar dprats avatar enzoh avatar ericswanson-dfinity avatar eve832 avatar fifteen42 avatar ggreif avatar gobengo avatar hoosan avatar jensgroth avatar jwiegley avatar krpeacock avatar lsgunnlsgunn avatar o0x avatar oggy-dfin avatar olaszakos avatar omegak avatar p-shahi avatar yotamhc avatar yvonneanne avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.