Skip to content

Commit

Permalink
Merge pull request #121 from filecoin-project/fatman
Browse files Browse the repository at this point in the history
update zh UI
  • Loading branch information
hunjixin authored Jun 26, 2021
2 parents 81eccf9 + 766662e commit 00f271a
Show file tree
Hide file tree
Showing 41 changed files with 901 additions and 648 deletions.
52 changes: 42 additions & 10 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ module.exports = {
'/zh/': {
lang: 'zh-CN',
title: '启明星',
description: 'Venus是完全兼容Filecoin分布式存储网络的一个go版本代码实现',
description: 'GO语言实现的Filecoin分布式存储网络',
}
},
themeConfig: {
Expand Down Expand Up @@ -141,43 +141,75 @@ module.exports = {
title: '启明星',
description: 'Venus is a Go implementation of the Filecoin Distributed Storage Network.',
nav: [
{
text: '快速上手',
link: '/zh/guide/'
},
{
text: '启明星模块',
link: '/zh/modules/'
},
{
text: '进阶',
link: '/zh/advanced/'
},
{
text: '孵化器',
link: '/zh/incubation/'
}
],
sidebar: {
'/zh/': [
'/zh/guide/': [
{
title: '快速上手',
collapsable: true,
collapsable: false,
children: [
['', '启明星概要'],
['How-To-Deploy-MingPool.md', '如何部署矿池'],
// ['Using-venus-Shared-Modules.md', '如何加入矿池'],
['Using-venus-Shared-Modules.md', '如何加入矿池'],
['Venus-replace-lotus.md', '从Lotus迁移到Venus'],
['chain.md', '链维护'],
['How-To-Connect-Network.md', '加入不同网络'],
['How-To-Contribute-Docs.md', '贡献文档']
]
},
}
],
'/zh/modules/': [
{
title: '模块',
collapsable: true,
title: '启明星模块',
collapsable: false,
children: [
['', 'Venus daemon'],
['How to use venus messager.md', 'Venus messager'],
['How-To-Use-Wallet-In-Venus.md', 'Venus wallet'],
// ['Venus-wallet.md', 'Venus wallet'],
['Venus-Worker.md', 'Venus worker'],
]
},
}
],
'/zh/advanced/': [
{
title: '进阶',
collapsable: true,
collapsable: false,
children: [
['Commands.md', 'CLI命令'],
['', 'CLI命令'],
['Tips-Running-In-China.md', '中国部署提示'],
['Multisig-Wallet.md', '多签钱包'],
['venus_load_balancing.md', '负载均衡'],
['Payment-Channel.md', '支付通道'],
['How-To-Setup_2knet.md', '本地2k开发网络'],
]
}
],
'/zh/incubation/': [
{
title: '孵化器',
collapsable: false,
children: [
['', '如何部署矿池'],
['Using-venus-Shared-Modules.md', '如何加入矿池'],
]
}
]
}
}
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 0 additions & 2 deletions docs/guide/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Overview of Venus

## Preface

Multiple interoperable software implementations are required on the same blockchain. Each implementation has its own set of security issues, but they are not all the same . Therefore, launching cryptocurrency networks with multiple implementations can reduce the catastrophic errors. Venus is one of the implementations of Filecoin network.
Expand Down
8 changes: 4 additions & 4 deletions docs/guide/Venus-replace-lotus.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ The shared moduler of the Venus service include: [venus](https://github.com/file
* Replace lotus-miner with venus-sealer and restart the service. For deployment of venus-sealer, please refer to [How-To-Deploy-MingPool](How-To-Deploy-MingPool.md)

Lotus cluster process before replacement
![lotus-cluster-1](../zh/images/lotus-cluster-1.png)
![lotus-cluster-1](/lotus-cluster-1.png)


Venus cluster process after replacement
![venus-replace-lotus-cluster-1](../zh/images/venus-replace-lotus-cluster-1.png)
![venus-replace-lotus-cluster-1](/venus-replace-lotus-cluster-1.png)

##### Scheme 2: customized lotus-miner moduler replacement

Expand All @@ -73,8 +73,8 @@ Because of the fact that the miners have modified the lotus-miner code, if they
* Miners can develop related tools by themselves, or wait for Venus developers to launch related tools and developer documents.

Lotus cluster process before replacement
![lotus-cluster-2](../images/lotus-cluster-2.png)
![lotus-cluster-2](/lotus-cluster-2.png)


Venus cluster process after replacement
![venus-replace-lotus-cluster-2](../images/venus-replace-lotus-cluster-2.png)
![venus-replace-lotus-cluster-2](/venus-replace-lotus-cluster-2.png)
2 changes: 1 addition & 1 deletion docs/mine/hardware-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,4 @@ As mentioned, the Miners have to perform operations of different nature which di

## About hardware requirements

The above requirements will not increase in the presumable future, and money spent on hardware should provide users with many years of reliable service, paying for themselves several times over.
The above requirements will not increase in the presumable future, and money spent on hardware should provide users with many years of reliable service, paying for themselves several times over.
2 changes: 1 addition & 1 deletion docs/mine/how-mining-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ Each Filecoin miner has an associated _power_ value in the network that is propo

Additionally, miners submit storage proofs regularly to the chain. This enables them to obtain _storage fees_ from the clients that have made deals with them.

Additional details about this can be found in the [mining rewards](mining-rewards.md) section.
Additional details about this can be found in the [mining rewards](mining-rewards.md) section.
2 changes: 1 addition & 1 deletion docs/mine/mining-architectures.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ A PDF is available for download [here](https://filecoin.io/vintage/mining-hardwa
| -------------------- | ----------------------------- | -------------------------- | ---------- | --------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| Storage miner + Node | AMD Epyc 7402 (24 cores) | Nvidia Quadro RTX 6000 | 128-256GB | Unspecified | 1x venus <br /><br />1x venus-miner | The miner delegates sealing functions to the workers below. |
| PC1 workers | AMD Epyc 7F32 DP/UP (8 cores) | - | 128-256GiB | 6 x 1-2TiB SSD scratch disk | 6x venus-worker | Runs 6 Venus seal workers in parallel for PreCommit1 phase only. |
| PC2, Commit workers | AMD Epyc 7402 (24 cores) | 2 x Nvidia Quadro RTX 6000 | 256GiB | 2-4TiB SSD scratch disk(s) | 1x venus-worker (PC2) <br /><br /> 1x venus-worker (Commit) | One worker dedicated to PreCommit2 and another to the Commit phase |
| PC2, Commit workers | AMD Epyc 7402 (24 cores) | 2 x Nvidia Quadro RTX 6000 | 256GiB | 2-4TiB SSD scratch disk(s) | 1x venus-worker (PC2) <br /><br /> 1x venus-worker (Commit) | One worker dedicated to PreCommit2 and another to the Commit phase |
2 changes: 1 addition & 1 deletion docs/mine/mining-rewards.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ To further incentivize the storage of "useful" data over simple capacity commitm

## Retrieval fees

Retrieval fees are paid incrementally using _payment channels_ as the retrieval deals are fulfilled (by sending portions of the data to the cl. This happens off-chain.
Retrieval fees are paid incrementally using _payment channels_ as the retrieval deals are fulfilled (by sending portions of the data to the cl. This happens off-chain.
2 changes: 1 addition & 1 deletion docs/mine/slashing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ This term encompasses a broader set of penalties which are to be paid by miners

## Consensus fault slashing

This penalty is incurred when committing consensus faults. This penalty is applied to miners that have acted maliciously against the network's consensus functionality.
This penalty is incurred when committing consensus faults. This penalty is applied to miners that have acted maliciously against the network's consensus functionality.
2 changes: 1 addition & 1 deletion docs/mine/venus/gpus.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ First, to watch GPU utilization run `nvtop` in one terminal, then in a separate
./Venus-bench sealing --sector-size=2KiB
```

This process uses a fair amount of GPU, and generally takes ~4 minutes to complete. If you do not see any activity in nvtop from venus during the entire process, it is likely something is misconfigured with your GPU.
This process uses a fair amount of GPU, and generally takes ~4 minutes to complete. If you do not see any activity in nvtop from venus during the entire process, it is likely something is misconfigured with your GPU.
2 changes: 1 addition & 1 deletion docs/mine/venus/message-pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ The _GasLimit_ should not be changed under normal circumstances. For instruction

```sh
venus mpool replace --help
```
```
2 changes: 1 addition & 1 deletion docs/mine/venus/miner-addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,4 +203,4 @@ venus-miner actor withdraw <amount>

::: tip
The owner's address will need to be available in the Venus node and have enough funds to pay for the gas for this transaction. Cold addresses will need to be temporally imported for the operation to succeed.
:::
:::
2 changes: 1 addition & 1 deletion docs/mine/venus/sealer-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ For any configuration changes to take effect, the miner must be restarted.
Timeout = "30s"
```

Configure `RemoteListenAddress` to the value that a different node would have to use to reach this API. Usually it is the miner's IP address and API port, but depending on your setup (proxies, public IPs etc.), it might be a different IP.
Configure `RemoteListenAddress` to the value that a different node would have to use to reach this API. Usually it is the miner's IP address and API port, but depending on your setup (proxies, public IPs etc.), it might be a different IP.
2 changes: 1 addition & 1 deletion docs/modules/How-To-Use-Messager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

messager is a component used to manage local messages, with the purpose of saving address messages, managing message status, and controlling the frequency of push messages.

[TOC]
[[TOC]]

## Getting start

Expand Down
23 changes: 23 additions & 0 deletions docs/zh/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
home: true
heroImage: /assets/venus-hero-logo.png
actionText: 快速上手 →
actionLink: /zh/guide/
footer: MIT Apache dual Licensed
---

<div class="features">
<div class="feature">
<h2>安全</h2>
<p>使用我们多样的安全功能保护您的私钥和存储服务。</p>
</div>
<div class="feature">
<h2>易用</h2>
<p>模块化组件和更少的运维投入,让您更快上手。</p>
</div>

<div class="feature">
<h2>矿池</h2>
<p>与其他存储提供商共享基础服务,释放您的真正潜力!</p>
</div>
</div>
Loading

0 comments on commit 00f271a

Please sign in to comment.