Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Submit Chinese version of Lava documentation #272

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/lava-docs.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

88 changes: 44 additions & 44 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,77 @@
# Welcome to Lava docs contributing guide <!-- omit in toc -->
# 欢迎来到Lava文档贡献指南 <!-- omit in toc -->

> First of all - THANK YOU for taking the time to contribute! 🌋👍
> 首先-感谢您花时间贡献! 🌋👍

This website is built using [Docusaurus 2](https://docusaurus.io/), all your changes will be reflected on Lava Docs @ [docs.lavanet.xyz](https://docs.lavanet.xyz)
本网站是使用[Docusaurus 2](https://docusaurus.io/)建立的,您的所有更改将反映在Lava Docs @ [docs.lavanet.xyz](https://docs.lavanet.xyz)上。

### How can you help 💪?
1. Report an issue/mistake you found
2. Suggest a fix via PR (read below)
3. Want to add new content/tutorials? Please propose it first via a new issue, and only then write it up, to save you time
### 你能帮什么忙? 💪?
1. 报告你发现的问题/错误
2. 通过PR提出修复建议(请阅读下文)
3. 想要添加新的内容/教程?请先通过New issue提出,然后再写出来,这样可以节省时间

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
在本指南中,您将获得从打开问题,创建PR,审查和合并PR的贡献工作流程的概述。

## New contributor guide
## 新贡献者指南

To get an overview of Lava, read the [Docs Intro](/docs/intro.md).
要获得Lava的概述,请阅读[Docs简介](/docs/intro.md)

This repository aligns with best practices for contributing to open source as you will find in many repositories on GitHub. If you are not familiar with these, please start with these great resources:
这个存储库符合为开源做出贡献的最佳实践,就像你在GitHub上的许多存储库中发现的那样。如果你不熟悉这些,请从这些伟大的资源开始:
- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)

## Styleguide
Lava docs serves multiple user types in different lifecycle steps.
We want to create a doc resource that will fit all, but have a common denominator of style.
## 格式指南
Lava docs在不同的生命周期步骤中为多种用户类型提供服务。
我们想创建一个文档资源,它将适合所有人,但有一个共同的风格。

Styleguides are guidance and not a restriction, good articles we picked for this purpose are:
- When it comes to git opeartions, we recommend https://cbea.ms/git-commit/
- When it is docs actual content, we recommend https://medium.com/larimaza-en/how-to-write-good-documentation-e19c70dc67f0
风格指南是指导而不是限制,为此我们挑选的好文章有:
- 当涉及到git操作时,我们建议 https://cbea.ms/git-commit/
- 当它是文档实际内容时,我们推荐 https://medium.com/larimaza-en/how-to-write-good-documentation-e19c70dc67f0

## Getting started
## 开始

### Issues

#### Create a new issue
#### 创建 new issue

If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/lavanet/docs/issues/new/choose).
如果你发现了文档中的问题,[如果问题已经存在,请搜索](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments)。如果相关的问题不存在,您可以使用相关的[问题表单](https://github.com/lavanet/docs/issues/new/choose)打开一个新问题。

#### Solve an issue
#### 解决 issue

Scan through our [existing issues](https://github.com/lavanet/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. If you find an issue to work on, you are welcome to open a PR with a fix.
浏览我们的[现有问题](https://github.com/lavanet/docs/issues),找到一个您感兴趣的。你可以使用`labels`作为过滤器来缩小搜索范围。如果你发现了一个需要解决的问题,欢迎你打开一个修复的PR。

### Make Changes
### 做出更改

#### Make changes to content
#### 修改内容

Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and create a pull request for a review.
点击任何文档页面底部的**贡献代码** (**Make a contribution**),进行一些小的更改,例如拼写错误、句子修复或链接损坏。这将带你到`。Md `文件,您可以在其中进行更改并创建一个pull request以进行审查。

#### Make changes locally
#### 在本地进行修改

1. Install Git
2. Fork the repository
3. Clone it to your working space
4. Run a local version using `$ yarn start`
5. Create a working branch and start with your changes!
1. 安装 Git
2. Fork仓库
3. 克隆到你的工作空间
4. 使用`$ yarn start`运行本地版本
5. 创建一个工作分支并开始修改!

### Commit & Pull Request

Commit the changes once you are happy with them.
一旦你对修改感到满意,就提交修改。

When you're finished with the changes, create a pull request, also known as a PR.
- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
Once you submit your PR, a team member will review your proposal. We may ask questions or request for additional information.
- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
- If you run into any merge issues, checkout this [git tutorial](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github) to help you resolve merge conflicts and other issues.
当您完成更改后,创建拉取请求,也称为PR。
- 填写“Ready for review”模板,这样我们就可以审查你的PR。这个模板可以帮助审稿人了解你的更改以及你的pull请求的目的。
- 如果你正在解决一个问题,不要忘记[链接PR到问题](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
- 启用复选框 [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) 因此分支可以为合并而更新。
一旦你提交了你的PR,一个团队成员会审查你的提案。我们可能会提出问题或要求提供更多信息。
- 我们可能会要求在合并PR之前进行更改,或者使用[suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) 或者拉请求注释。您可以直接通过UI应用建议的更改。您可以在您的分支中进行任何其他更改,然后将它们提交到您的分支。
- 当您更新PR并应用更改时,将每个对话标记为[resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
- 如果您遇到任何合并问题,请签出此 [git tutorial](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github) 帮助您解决合并冲突和其他问题。

### Your PR is merged!
### 你的 PR 已被 merged!

Congratulations 🦸 Lava thanks you 🌋🙏.
祝贺🦸,Lava感谢你🌋🙏。

Once your PR is merged, your contributions will be publicly visible on the [Lava Docs](https://docs.lavanet.xyz)
一旦你的PR被合并,你的贡献将在[Lava Docs](https://docs.lavanet.xyz)上公开可见。

_Thanks goes to [GitHub Docs](https://github.com/github/docs) for inspiration on writing this contribution text_
_感谢[GitHub Docs](https://github.com/github/docs)提供编写此贡献文本的灵感_
57 changes: 28 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,41 @@
![Banner](static/img/banner/Chains.jpg)

# Lava Documentation 📕
# Lava 文档 📕

[![Website](https://img.shields.io/badge/WEBSITE-https%3A%2F%2Fdocs.lavanet.xyz-green?style=for-the-badge)](https://docs.lavanet.xyz) &emsp; [![Discord](https://img.shields.io/discord/963778337904427018?color=green&logo=discord&logoColor=white&style=for-the-badge)](https://discord.gg/EKzbc6bx)


## Overview 🔎
## 概览 🔎

This repository (**@lavanet/docs**) contains technical documentation for the Lava ecosystem. The most recent version of this repository is deployed to the Lava docs [website](https://docs.lavanet.xyz/) and is viewable there. If you're averse to rich formatting, Lava Documentation can also be browsed as plain source in the markdown files available in the [docs folder](/docs/) of this repository. The Lava docs website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator, and deployed using the [Netlify Web Platform](https://www.netlify.com/).
这个仓库 (**@lavanet/docs**) 包含了 Lava 生态系统的技术文档。该仓库的最新版本已部署到 Lava 文档 [网站](https://docs.lavanet.xyz/) 并可在那里查看。如果你不喜欢丰富的格式,Lava 文档也可以在该仓库的 [docs 文件夹](/docs/) 中的 markdown 文件中以纯源码形式浏览。Lava 文档网站是使用 [Docusaurus 2](https://docusaurus.io/),一种现代静态网站生成器构建的,并使用 [Netlify Web 平台](https://www.netlify.com/) 部署的。

Contents include:
内容包括:

- Information on Lava's supported chains
- Installation & Setup Guides for Validators, Providers, and Developers
- Network & Protocol Details on Lava's Unique Features
- Links to in-demand RPC & Web3 APIs
-Lava支持链的信息
-针对验证者、提供者和开发人员的安装和设置指南
-关于Lava独特功能的网络和协议细节
-到需要的RPC和Web3 api的链接

## Contribution 👥
## 贡献 👥

Contributing to the documentation of Lava is a rewarding way to give back to the ecosystem. We always welcome contributors with love & kindness. After reviewing this README, please read the [contribution](CONTRIBUTING.md) guide to help you get started.
对Lava的记录做出贡献是回报生态系统的一种有益的方式。我们总是以爱心和善意欢迎贡献者。在审阅完这个自述文件后,请阅读[contribution](CONTRIBUTING.md)指南以帮助您开始。


## Deployment 🚀
## 部署 🚀

### Status
### 状态

[![Netlify Status](https://api.netlify.com/api/v1/badges/58c0a448-7af0-48d3-8e29-86fc4a6f4868/deploy-status)](https://app.netlify.com/sites/sage-swan-13ac7b/deploys)

### Process
The `main` branch of this repository is automatically deployed to our docs site, and other branches and pull requests leverage Netlify deploy. Please note that unless you are a recognized contributor of this repository, each attempted PR generates a Netlify approval that will prevent your pull request from being merged. Once the request is approved and a Netlify deploy preview is generated, a Netlify deploy preview will appear in the body of your PR as `😎 Deploy Preview`. This deploy preview will be audited by a docs maintainer before merging your pull request.
### 处理
这个仓库的`main`分支自动部署到我们的文档站点,其他分支和pull请求利用Netlify deploy。请注意,除非您是此存储库的公认贡献者,否则每次尝试PR都会生成一个Netlify批准,以防止您的pull request被合并。一旦请求被批准并生成一个Netlify部署预览版,一个Netlify部署预览版将出现在你的PR主体中,名为 `😎 Deploy Preview`。这个部署预览将由文档维护者在合并你的pull request之前进行审计。
## 本地开发 🔧

## Local Development 🔧
### 1. 分叉该版本库!

### 1. Fork this repository!
我们建议将您的 fork 命名为 `lava-docs`,以区别于其他可能有类似命名约定的项目。

We recommend naming your fork `lava-docs` to distinguish from other projects which might have similar naming conventions.

### 2. Clone your fork
### 2. 克隆你的分叉

SSH **(recommended)**

Expand All @@ -50,48 +49,48 @@ HTTPS
git clone https://github.com/Your-User-Name-Here/lava-docs.git
```

### 3. Set up environmental variables
### 3. 设置环境变量

```bash
cd lava-docs/
cp .env.example .env
```

Change the contents of your environmental variables(`.env`) file to the following:
将环境变量(`.env`)文件的内容更改为以下内容:

```
ALGOLIA_APP_ID=demo
ALGOLIA_API_KEY=demo
ALGOLIA_INDEX_NAME=demo
```

Algolia search needs values assigned to these in order to start. For local docs instances (w/ non-functional search), any dummy values will work.
Algolia 搜索需要为这些值赋值才能启动。对于本地文档实例(无功能搜索),任何虚值都可以使用。

### 4. Install all packages
### 4. 安装所有软件包

```
yarn install
```

### 5. Host a local preview of the docs (*Optional*)
### 5. 在本地预览文档(*可选*)。

```
yarn start
```

Your preview will dynamically change/hotload as you make changes to files.
当你对文件进行修改时,预览会动态更改/热载。

### 6. Build a local deployment of the docs (*Optional*)
### 6. 构建文档的本地部署(*可选*)。

```
yarn build
```

Your build will appear in the `./build/` folder of your docs directory.
您的构建将出现在文档目录下的 `./build/` 文件夹中。

### 7. Deploy to Github (*Optional*)
### 7. 部署到 Github(*可选*)。

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
如果使用 GitHub 页面托管,该命令可以方便地构建网站并推送到 `gh-pages` 分支。

```
$ GIT_USER=<Your GitHub username> yarn deploy
Expand Down
22 changes: 11 additions & 11 deletions docs/chains/agoric-chain/agoric-dev.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
slug: /agoric-dev
title: Getting Agoric RPC
title: 获取Agoric RPC
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Getting Agoric RPC
# 获取Agoric RPC

## Agoric ipRPC 🪙

Lava🌋 offers incentivized public RPC for Agoric. Developers can get free, public endpoints for all.
LAVA🌋为Agoric提供奖励公共RPC。开发者可以获得免费的公共终端。

### Mainnet 🌐

Expand All @@ -31,27 +31,27 @@ Lava🌋 offers incentivized public RPC for Agoric. Developers can get free, pub

## [Gateway](https://gateway.lavanet.xyz/?utm_source=agoric-dev&utm_medium=docs&utm_campaign=docs-to-gateway)

To learn more about using the Lava Gateway visit the [Getting Started guide](https://docs.lavanet.xyz/gateway-getting-started?utm_source=agoric-dev&utm_medium=docs&utm_campaign=docs-to-docs)
要了解有关使用Lava网关的更多信息,请访问[入门指南](https://docs.lavanet.xyz/gateway-getting-started?utm_source=agoric-dev&utm_medium=docs&utm_campaign=docs-to-docs)

<hr />

## [SDK](https://github.com/lavanet/lava-sdk)

### Input 📥
### 输入 📥

<Tabs>

<TabItem value="backend" label="BackEnd">

```jsx
// Install lavaSDK with the following command:
// 使用以下命令安装lavaSDK:
// npm i @lavanet/lava-sdk
const { LavaSDK } = require("@lavanet/lava-sdk")

async function useAgoricMainnet() {

const agoricMainnet = await LavaSDK.create({
privateKey: process.env.PRIVATE_KEY, //hide your private key in an environmental variable
privateKey: process.env.PRIVATE_KEY, //将私钥隐藏在环境变量中
chainIds: 'AGOR',
});

Expand Down Expand Up @@ -81,7 +81,7 @@ async function useAgoricMainnet() {

const agoricMainnet = await LavaSDK.create({
badge: {
badgeServerAddress: "https://badges.lavanet.xyz", // Or your own Badge-Server URL
badgeServerAddress: "https://badges.lavanet.xyz", // 或者您自己的徽章服务器URL
projectId: "enter_your_project_id_here"
},
chainIds: 'AGORT',
Expand All @@ -106,14 +106,14 @@ async function useAgoricMainnet() {
</Tabs>


### Output 📤
### 输出 📤

:::caution
Certain features of Agoric spec may not be currently enabled.
Agoric spec 的某些功能目前可能没有启用。
:::

<iframe width="100%" src="/img/chains/agoric_call.webm" frameborder="0" allow="autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

To learn more about our SDK visit the [Getting Started guide](https://docs.lavanet.xyz/sdk-getting-started?utm_source=getting-agoric-rpc&utm_medium=docs&utm_campaign=docs-to-docs)
要了解有关我们的SDK的更多信息,请访问[入门指南](https://docs.lavanet.xyz/sdk-getting-started?utm_source=getting-agoric-rpc&utm_medium=docs&utm_campaign=docs-to-docs)

<hr />
Loading