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.

Sign up for GitHub

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

docs: add link to doc #180

Merged
merged 6 commits into from
Mar 10, 2023
Merged

docs: add link to doc #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
201a74b
fix: add link to deployment doc
joeylichang Mar 10, 2023
d4e8512
fix: add link to setup local doc
joeylichang Mar 10, 2023
c79be96
fix: change dead link
joeylichang Mar 10, 2023
e037ecf
fix: uniform letter case
joeylichang Mar 10, 2023
7ee8c02
fix: uniform letter case
joeylichang Mar 10, 2023
7a2a713
fix: uniform letter case
joeylichang Mar 10, 2023
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
7 changes: 5 additions & 2 deletions docs/tutorial/01-deployment.md
View file
Open in desktop
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)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now use a personal branch, maybe we can use a stable branch?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes


## 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
View file
Open in desktop
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
```
```