Skip to content

Commit

Permalink
2021/12/27
Browse files Browse the repository at this point in the history
  • Loading branch information
@GongZiHao0430
GongZiHao0430 committed Dec 27, 2021
1 parent 99867ee commit 6a56a4a
Show file tree
Hide file tree
Showing 31 changed files with 651 additions and 724 deletions.
2 changes: 1 addition & 1 deletion docs/ja/404.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ footer:
aside: false
-->

# 404 - Lost in space, this is just an empty void
# 404-スペースで失われました、これはただの空のボイドです
112 changes: 56 additions & 56 deletions docs/ja/DOCS_README.md
View file
Original file line number Diff line number Diff line change
@@ -1,123 +1,123 @@
# Updating the docs
# ドキュメントの更新

If you want to open a PR in Cosmos SDK to update the documentation, please follow the guidelines in [`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/master/CONTRIBUTING.md#updating-documentation).
Cosmos SDKでPRを開いてドキュメントを更新する場合は、次のガイドラインに従ってください。[`CONTRIBUTING.md`](https://github.com/cosmos/cosmos-sdk/tree/master/CONTRIBUTING.md#updating-documentation)

## Internationalization
## 国際化

- Translations for documentation live in a `docs/<locale>/` folder, where `<locale>` is the language code for a specific language. For example, `zh` for Chinese, `ko` for Korean, `ru` for Russian, etc.
- Each `docs/<locale>/` folder must follow the same folder structure within `docs/`, but only content in the following folders needs to be translated and included in the respective `docs/<locale>/` folder:
- ドキュメントの翻訳は `docs/<locale>/`フォルダーにあります。ここで、 `<locale>`は特定の言語の言語コードです。 たとえば、中国語の場合は「zh」、韓国語の場合は「ko」、ロシア語の場合は「ru」などです。
- 各 `docs/<locale>/`フォルダは `docs/`内の同じフォルダ構造に従う必要がありますが、次のフォルダのコンテンツのみを翻訳して、それぞれの `docs/<locale>/`フォルダに含める必要があります。
- `docs/basics/`
- `docs/building-modules/`
- `docs/core/`
- `docs/ibc/`
- `docs/intro/`
- `docs/migrations/`
- `docs/run-node/`
- Each `docs/<locale>/` folder must also have a `README.md` that includes a translated version of both the layout and content within the root-level [`README.md`](https://github.com/cosmos/cosmos-sdk/tree/master/docs/README.md). The layout defined in the `README.md` is used to build the homepage.
- Always translate content living on `master` unless you are revising documentation for a specific release. Translated documentation like the root-level documentation is semantically versioned.
- For additional configuration options, please see [VuePress Internationalization](https://vuepress.vuejs.org/guide/i18n.html).
- 各 `docs/<locale>/`フォルダーには、ルートレベル[`README.md`](https://github。 com/cosmos/cosmos-sdk/tree/master/docs/README.md)。 `README.md`で定義されたレイアウトは、ホームページの構築に使用されます。
- 特定のリリースのドキュメントを改訂する場合を除き、常に `master`にあるコンテンツを翻訳してください。 ルートレベルのドキュメントのような翻訳されたドキュメントは、意味的にバージョン管理されています。
- その他の構成オプションについては、[VuePress Internationalization](https://vuepress.vuejs.org/guide/i18n.html)を参照してください。

## Docs Build Workflow
## ドキュメントビルドワークフロー

The documentation for Cosmos SDK is hosted at https://docs.cosmos.network/ and built from the files in the `/docs` directory.
Cosmos SDKのドキュメントはhttps://docs.cosmos.network/でホストされており、`/docs`ディレクトリ内のファイルから構築されています。

### How It Works
### 仕組み

There is a CircleCI job listening for changes in the `/docs` directory for the `master` branch and each supported version tag (`v0.39` and `v0.42`). Any updates to files in the `/docs` directory will automatically trigger a website deployment. Under the hood, the private website repository has a `make build-docs` target consumed by a CircleCI job within that repository.
`master`ブランチとサポートされている各バージョンタグ(` v0.39`と `v0.42`)の`/docs`ディレクトリの変更をリッスンするCircleCIジョブがあります。 `/docs`ディレクトリ内のファイルを更新すると、Webサイトの展開が自動的にトリガーされます。 内部的には、プライベートWebサイトリポジトリには、そのリポジトリ内のCircleCIジョブによって消費される `makebuild-docs`ターゲットがあります。

## README

The [README.md](./README.md) is both the README for the repository and the configuration for the layout of the landing page.
[README.md](./README.md)は、リポジトリのREADMEであると同時に、ランディングページのレイアウトの構成でもあります。

## Config.js

The [config.js](./.vuepress/config.js) generates the sidebar and Table of Contents
on the website docs. Note the use of relative links and the omission of
file extensions. Additional features are available to improve the look
of the sidebar.
[config.js](./.vuepress/config.js)は、サイドバーと目次を生成します
ウェブサイトのドキュメントで。相対リンクの使用との省略に注意してください
ファイル拡張子。外観を改善するための追加機能を利用できます
サイドバーの。

## Links
## リンク

**NOTE:** Strongly consider the existing links - both within this directory
and to the website docs - when moving or deleting files.
**注:**既存のリンクを強く検討してください-両方ともこのディレクトリ内にあります
およびWebサイトのドキュメントへ-ファイルを移動または削除する場合。

Relative links should be used nearly everywhere, having discovered and weighed the following:
相対リンクは、次のことを発見して評価した上で、ほぼすべての場所で使用する必要があります。

### Relative
### 相対的

Where is the other file, relative to the current one?
現在のファイルと比較して、他のファイルはどこにありますか？

- works both on GitHub and for the VuePress build
- confusing / annoying to have things like: `../../../../myfile.md`
- requires more updates when files are re-shuffled
- GitHubとVuePressビルドの両方で機能します
- 混乱する/煩わしい: `../../../../myfile.md`
- ファイルが再シャッフルされるときに、より多くの更新が必要です

### Absolute
### 絶対

Where is the other file, given the root of the repo?
リポジトリのルートを指定すると、他のファイルはどこにありますか？

- works on GitHub, doesn't work for the VuePress build
- this is much nicer: `/docs/hereitis/myfile.md`
- if you move that file around, the links inside it are preserved (but not to it, of course)
- GitHubで動作し、VuePressビルドでは動作しません
- これははるかに優れています: `/docs/hereitis/myfile.md`
- そのファイルを移動すると、その中のリンクは保持されます(もちろん、ファイルへのリンクは保持されません)。

### Full
### 満杯

The full GitHub URL to a file or directory. Used occasionally when it makes sense
to send users to the GitHub.
ファイルまたはディレクトリへの完全なGitHubURL。意味があるときに時々使用されます
ユーザーをGitHubに送信します。

## Building Locally
## ローカルで構築する

Make sure you are in the `docs` directory and run the following commands:
`docs`ディレクトリにいることを確認し、次のコマンドを実行します。

```sh
rm -rf node_modules
```

This command will remove old version of the visual theme and required packages. This step is optional.
このコマンドは、古いバージョンのビジュアルテーマと必要なパッケージを削除します。 このステップはオプションです。

```sh
npm install
```

Install the theme and all dependencies.
テーマとすべての依存関係をインストールします。

```sh
npm run serve
```

Run `pre` and `post` hooks and start a hot-reloading web-server. See output of this command for the URL (it is often https://localhost:8080).
`pre`フックと` post`フックを実行し、ホットリロードWebサーバーを起動します。 URLについては、このコマンドの出力を参照してください(多くの場合、https://localhost:8080です)。

To build documentation as a static website run `npm run build`. You will find the website in `.vuepress/dist` directory.
ドキュメントを静的Webサイトとしてビルドするには、 `npm runbuild`を実行します。 Webサイトは `.vuepress/dist`ディレクトリにあります。

## Build RPC Docs
## RPCドキュメントを作成する

First, run `make tools` from the root of repo, to install the swagger-ui tool.
まず、リポジトリのルートから `make tools`を実行して、swagger-uiツールをインストールします。

Then, edit the `swagger.yaml` manually; it is found [here](https://github.com/cosmos/cosmos-sdk/blob/master/client/lcd/swagger-ui/swagger.yaml)
次に、 `swagger.yaml`を手動で編集します。 [ここ](https://github.com/cosmos/cosmos-sdk/blob/master/client/lcd/swagger-ui/swagger.yaml)にあります

Finally, run `make update_gaia_lite_docs` from the root of the repo.
最後に、リポジトリのルートから `makeupdate_gaia_lite_docs`を実行します。

## Search
## 検索

We are using [Algolia](https://www.algolia.com) to power full-text search. This uses a public API search-only key in the `config.js` as well as a [cosmos_network.json](https://github.com/algolia/docsearch-configs/blob/master/configs/cosmos_network.json) configuration file that we can update with PRs.
全文検索を強化するために[Algolia](https://www.algolia.com)を使用しています。 これは、 `config.js`のパブリックAPI検索専用キーと[cosmos_network.json](https://github.com/algolia/docsearch-configs/blob/master/configs/cosmos_network.json)を使用します PRで更新できる構成ファイル。

## Consistency
## 一貫性

Because the build processes are identical (as is the information contained herein), this file should be kept in sync as
much as possible with its [counterpart in the Tendermint Core repo](https://github.com/tendermint/tendermint/blob/v0.34.0/docs/DOCS_README.md).
ビルドプロセスは(ここに含まれる情報と同様に)同一であるため、このファイルは次のように同期を維持する必要があります。
[Tendermint Coreリポジトリのカウンターパート](https://github.com/tendermint/tendermint/blob/v0.34.0/docs/DOCS_README.md)で可能な限り。

### Update and Build the RPC docs
### RPCドキュメントを更新してビルドする

1. Execute the following command at the root directory to install the swagger-ui generate tool.
1. ルートディレクトリで次のコマンドを実行して、swagger-ui生成ツールをインストールします。

```bash
make tools
```

2. Edit API docs
1. Directly Edit API docs manually: `client/lcd/swagger-ui/swagger.yaml`.
2. Edit API docs within the [Swagger Editor](https://editor.swagger.io/). Please refer to this [document](https://swagger.io/docs/specification/2-0/basic-structure/) for the correct structure in `.yaml`.
3. Download `swagger.yaml` and replace the old `swagger.yaml` under fold `client/lcd/swagger-ui`.
4. Compile gaiacli
2. APIドキュメントを編集します
1. APIドキュメントを手動で直接編集します: `client/lcd/swagger-ui/swagger.yaml`。
2. [Swagger Editor](https://editor.swagger.io/)内でAPIドキュメントを編集します。 `.yaml`の正しい構造については、この[ドキュメント](https://swagger.io/docs/specification/2-0/basic-structure/)を参照してください。
3. `swagger.yaml`をダウンロードし、fold` client/lcd/swagger-ui`の下にある古い` swagger.yaml`を置き換えます。
4. gaiacliをコンパイルします

```bash
make install
Expand Down
22 changes: 11 additions & 11 deletions docs/ja/DOC_WRITING_GUIDELINES.md
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Documentation Writing Guidelines
# ドキュメント作成ガイドライン

## Best Practices
## ベストプラクティス

+ Check the spelling and grammar, even if you have to copy and paste from an external source.
+ Use simple sentences. Easy-to-read sentences mean the reader can quickly use the guidance you share.
+ Try to express your thoughts in a concise and clean way.
+ Don't abuse `code` format when writing in plain English.
+ Follow Google developer documentation [style guide](https://developers.google.com/style).
+ Check the meaning of words in Microsoft's [A-Z word list and term collections](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms) (use the search input!).
+ RFC keywords should be used in technical documents (uppercase) and we recommend to use them in user documentation (lowercase). The RFC keywords are: "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL. They are to be interpreted as described in [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119).
+ 外部ソースからコピーして貼り付ける必要がある場合でも、スペルと文法を確認してください。
+ 簡単な文章を使用します。読みやすい文章は、読者があなたが共有するガイダンスをすばやく使用できることを意味します。
+ あなたの考えを簡潔でクリーンな方法で表現するようにしてください。
+ 平易な英語で書くときは、 `code`形式を乱用しないでください。
+ Google開発者向けドキュメント[スタイルガイド](https://developers.google.com/style)に従ってください。
+ Microsoftの[AZ単語リストと用語コレクション](https://docs.microsoft.com/en-us/style-guide/az-word-list-term-collections/term-collections/accessibility)で単語の意味を確認します-用語)(検索入力を使用してください！)。
+ RFCキーワードは、技術文書(大文字)で使用する必要があり、ユーザー文書(小文字)で使用することをお勧めします。 RFCキーワードは、「MUST」、「MUST NOT」、「REQUIRED」、「SHALL」、「SHALL NOT」、「SHOULD」、「SHOULD NOT」、「RECOMMENDED」、「MAY」、および「OPTIONAL」です。 [RFC 2119](https://datatracker.ietf.org/doc/html/rfc2119)で説明されているように解釈されます。

## Technical Writing Course
## テクニカルライティングコース

Google provides a free [course](https://developers.google.com/tech-writing/overview) for technical writing.
Googleは、テクニカルライティングのための無料の[コース](https://developers.google.com/tech-writing/overview)を提供しています。
48 changes: 24 additions & 24 deletions docs/ja/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,39 +43,39 @@ footer:
aside: false
-->

# Cosmos SDK 文档
# CosmosSDKドキュメント

## 开始
## はじめに

- **[Cosmos SDK Intro](./intro/overview.md)**:Cosmos SDK 的高级概述。
- **[Starport](https://docs.starport.network/)**:Cosmos SDK 的开发人员友好界面，用于在主权和安全的区块链上搭建、启动和维护任何加密应用程序。
- **[SDK 教程](https://tutorials.cosmos.network/)**:展示如何从头开始构建基于 Cosmos SDK 的区块链的教程，并解释了该过程中的基本 Cosmos SDK 原理。
- **[Cosmos SDK Intro](./intro/overview.md)**:CosmosSDKの概要。
- **[Starport](https://docs.starport.network/)**:Cosmos SDKの開発者向けのインターフェイスは、暗号化されたアプリケーションをソブリンで安全なブロックチェーン上で構築、起動、および保守するために使用されます。
- **[SDK Tutorials](https://tutorials.cosmos.network/)**:Cosmos SDKに基づいてブロックチェーンを最初から構築する方法を示し、その過程でCosmosSDKの基本原則を説明するチュートリアル。

## 参考文档
## 参考資料

- **[Basics](./basics/)**:Cosmos SDK 的基本概念，包括应用的标准剖析、交易生命周期和账户管理。
- **[Core](./core/)**:Cosmos SDK 的核心概念，包括`baseapp`、`store` 或`server`。
- **[Building Modules](./building-modules/)**:模块开发人员的重要概念，如`message`、`keeper`和`querier`。
- **[IBC](./ibc/)**:IBC 协议集成和概念。
- **[运行节点、API、CLI](./run-node/)**:如何使用 CLI 和 API 运行节点并与节点交互。
- **[Migrations](./migrations/)**:更新到新版本 Cosmos SDK 的迁移指南。
- **[Basics](./basics/)**:アプリケーション標準分析、トランザクションライフサイクル、アカウント管理など、CosmosSDKの基本概念。
- **[Core](./core/)**:`baseapp`、` store`、または `server`を含むCosmosSDKのコアコンセプト。
- **[Building Modules](./building-modules/)**:`message`、` keeper`、 `querier`などのモジュール開発者にとって重要な概念。
- **[IBC](./ibc/)**:IBCプロトコルの統合と概念。
- **[运行节点、API、CLI](./run-node/)**:ノードを実行し、CLIとAPIを使用してノードと対話する方法。
- **[Migrations](./migrations/)**:CosmosSDKの新しいバージョンに更新するための移行ガイド。

## 其他资源
## その他のリソース

- **[模块目录](../x/)**:Cosmos SDK 模块实现及其各自的文档。
- **[Specifications](./spec/)**:Cosmos SDK 的模块和其他部分的规范。
- **[Cosmos SDK API 参考](https://godoc.org/github.com/cosmos/cosmos-sdk)**:Cosmos SDK 的 Godocs。
- **[REST 和 RPC 端点](https://cosmos.network/rpc/)**:与`gaia` 全节点交互的端点列表。
- **[Rosetta API](./run-node/rosetta.md)**:Rosetta API 集成。
- **[Module Directory](../x/)**:CosmosSDKモジュールの実装とそれぞれのドキュメント。
- **[Specifications](./spec/)**:CosmosSDKのモジュールおよびその他の部分の仕様。
- **[Cosmos SDK API 参照](https://godoc.org/github.com/cosmos/cosmos-sdk)**:CosmosSDKのGodocs。
- **[RESTとRPCエンドポイント](https://cosmos.network/rpc/)**:`gaia`フルノードと対話するエンドポイントのリスト。
- **[Rosetta API](./run-node/rosetta.md)**:RosettaAPI統合。

## Cosmos Hub
## コスモスハブ

Cosmos Hub (`gaia`) 文档已移至 [github.com/cosmos/gaia](https://github.com/cosmos/gaia/tree/master/docs)。
Cosmos Hub（ `gaia`）のドキュメントは[github.com/cosmos/gaia]（https://github.com/cosmos/gaia/tree/master/docs）に移動しました。

## 开发语言
## 言語

Cosmos SDK 是用 [Golang](https://golang.org/) 编写的，尽管该框架可以用其他语言类似地实现。联系我们以获取有关为另一种语言的实施提供资金的信息。
Cosmos SDKは[Golang]（https://golang.org/）で記述されていますが、フレームワークは他の言語でも同様に実装できます。 別の言語での実装への資金提供については、お問い合わせください。

## 贡献
## 貢献する

有关构建过程的详细信息和进行更改时的注意事项，请参阅 [DOCS_README.md](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md)。
ビルドプロセスの詳細と変更を行う際の考慮事項については、[DOCS_README.md]（https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOCS_README.md）を参照してください。
Loading

0 comments on commit 6a56a4a

Please sign in to comment.