Skip to content

Commit

Permalink
doc: add link to doc (#180)
Browse files Browse the repository at this point in the history
* fix: add links to deployment and setup local docs
  • Loading branch information
joeylichang committed Mar 13, 2023
1 parent 2e6c0f5 commit 06ff172
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
7 changes: 5 additions & 2 deletions docs/tutorial/01-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,18 @@ Build : go1.20.1 darwin amd64 2023-03-04 23:54
```

## Join greenfield chain
> TODO:: waiting for the greenfield chain doc pr merged
[join mainnet, join testnet, setup private netWork](https://github.com/bnb-chain/greenfield/tree/master/docs/tutorial)

## Add SP to greenfield chain
[add sp to greenfield chain](https://github.com/bnb-chain/greenfield/blob/fynn/doc/docs/tutorial/07-storage-provider.md)

## Make configuration
```shell
# dump the configuration template to './config.toml'
./gnfd-sp config.dump
```

[Edit configuration template](https://github.com/bnb-chain/greenfield-storage-provider/blob/develop_opt/docs/tutorial/02-config-template.toml)
[edit configuration template](https://github.com/bnb-chain/greenfield-storage-provider/blob/develop/docs/tutorial/02-config-template.toml)

## Start with local model
```shell
Expand Down
10 changes: 6 additions & 4 deletions docs/tutorial/03-localup.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@

## Dependence
* SQLDB: MariaDB - 5.5.68 and Aurora(MySQL 5.7) 2.10.3 has been practiced.
* Greenfield: [setup local chain](https://github.com/bnb-chain/greenfield/tree/master/deployment)

## SP join Greenfield local chain
> TODO:: waiting for the greenfield chain doc pr merged
## Setup local greenfield chain
[setup private netWork](https://github.com/bnb-chain/greenfield/blob/master/docs/tutorial/03-local-network.md)

## Add SP to greenfield chain
[add sp to greenfield chain](https://github.com/bnb-chain/greenfield/blob/fynn/doc/docs/tutorial/07-storage-provider.md)

## Setup local sps
1. Generate localup env
Expand Down Expand Up @@ -69,4 +71,4 @@ Usage: deployment/localup/localup.sh [option...] {help|reset|start|stop|print}
--start start storage providers
--stop stop storage providers
--print print sp local env work directory
```
```

0 comments on commit 06ff172

Please sign in to comment.