feat: rework documentation #571
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
DylanVerstraete
requested review from
brandonpille,
renauter,
robvanmieghem and
LeeSmet
as code owners
| @@ -1,21 +0,0 @@ | |||
| # Tfchain terminolog | |||
There was a problem hiding this comment.
I know most of this is deprecated but the definition of a Validator or Council member are nowhere else
There was a problem hiding this comment.
What do you mean by this?
xmonader
reviewed
Jan 23, 2023
xmonader
reviewed
Jan 23, 2023
xmonader
reviewed
Jan 23, 2023
xmonader
reviewed
Jan 23, 2023
xmonader
reviewed
Jan 23, 2023
xmonader
reviewed
Jan 23, 2023
xmonader
reviewed
Jan 23, 2023
xmonader
reviewed
Jan 23, 2023
| @@ -0,0 +1,11 @@ | |||
| ## Production | |||
There was a problem hiding this comment.
can we also link to ours, also we should use the production release binaries in the repository, also where is our custom spec file?
There was a problem hiding this comment.
why would we need to link to our chainspecs?
maayarosama
reviewed
Jan 23, 2023
maayarosama
reviewed
Jan 24, 2023
maayarosama
reviewed
Jan 24, 2023
maayarosama
reviewed
Jan 24, 2023
DylanVerstraete
requested review from
robvanmieghem,
maayarosama and
xmonader
maayarosama
reviewed
Jan 24, 2023
maayarosama
reviewed
Jan 24, 2023
maayarosama
reviewed
Jan 24, 2023
maayarosama
reviewed
Jan 24, 2023
docs/development/development.md
Outdated
|
|
||
| ## Get the code | ||
|
|
||
| ``` |
There was a problem hiding this comment.
It's unclear what is commented here..
There was a problem hiding this comment.
For every highlighted command it should be a highlighted bash command like the following:
maayarosama
reviewed
Jan 24, 2023
docs/development/development.md
Outdated
|
|
||
| ## Installing and running tfchain in dev mode | ||
|
|
||
| ``` |
maayarosama
reviewed
Jan 24, 2023
docs/development/development.md
Outdated
|
|
||
| To wipe data run: | ||
|
|
||
| ``` |
maayarosama
reviewed
Jan 24, 2023
docs/development/local_multinode.md
Outdated
|
|
||
| ## Compile release build | ||
|
|
||
| ``` |
maayarosama
reviewed
Jan 24, 2023
docs/development/local_multinode.md
Outdated
|
|
||
| In a terminal window execute the following command: | ||
|
|
||
| ``` |
maayarosama
reviewed
Jan 24, 2023
docs/development/local_multinode.md
Outdated
|
|
||
| In a second terminal window executing the following command: | ||
|
|
||
| ``` |
maayarosama
reviewed
Jan 24, 2023
maayarosama
reviewed
Jan 25, 2023
| - Mainnet: 1.0.0 (git checkout 1.0.0) | ||
| - Testnet: 1.0.0-b1 (git checkout 1.0.0-b1) | ||
| - Devnet: 1.0.0-b9 (git checkout 1.0.0-b9) | ||
| Check release page on github to check which binary to use. |
There was a problem hiding this comment.
Please link the release page here.
maayarosama
reviewed
Jan 25, 2023
docs/production/key_generation.md
Outdated
|
|
||
| Keys are generated using [subkey](https://substrate.dev/docs/en/knowledgebase/integrate/subkey) or use `tfchain key`. | ||
|
|
||
| For each validator generate a key: |
There was a problem hiding this comment.
Might be helpful to users to mention what's a validator.
DylanVerstraete
added a commit
that referenced
this pull request
Apr 12, 2023
* feat: rework documentation (#571) * doc: service consumer contract flow (#567) * fix: farming policies map ids (#591) * chore: reset runtime migrations * feat: delete twin is not allowed (#586) * fix: typos (#595) * fix: locked balances (#590) * feat: allow twin to connect to a relay (#570) * chore: bump to version 2.3.0-rc1 (specVersion: 124) * feat: add node power (#592) * chore: update ADR docs * chore: bump to version 2.3.0-rc2 (specVersion: 125) * chore: rework logging pallet smart contract * fix: allow numbers in relay addresses * chore: bump to version 2.3.0-rc3 (specVersion: 125) * fix: migration V15 for devnet #598 * chore: bump to version 2.3.0-rc4 (specVersion: 127) * chore: restore V15 migration * chore: update dev chain spec * fix: soften serial number validation (#603) * chore: set max length of serial number to 128 bytes * chore: align tft bridge dependency * chore: update default dev chainspec * chore: revert default dev bridge validators chainspec * Drop unused structopt dependency This also removes some unused child dependencies Signed-off-by: Lee Smet <lee.smet@hotmail.com> * Set the substrate node default chart image to ghcr.io * fix: rework balances migrations * chore: refactor * feat: also remove contract and lock if twin is deleted * chore: add writes * chore: resolve comment * chore: fix ci * chore: resolve pr comments * chore: add log * Update build_test.yaml to use the new runner (#617) * chore: remove serial valdiation (#616) * chore: bump to version 2.3.0-rc6 (specVersion: 129) * chore: rework chart #620 * fix: discount calculation handle variable billing frequency (#626) * fix: migrations for v2.3.0 (#627) * chore: bump to version 2.3.0-rc7 (specVersion: 130) * fix: soften node city/country validation * chore: bump to version 2.3.0-rc8 (specVersion: 131) * chore: update cargo lock * chore: bump version to 2.3.0 --------- Signed-off-by: Lee Smet <lee.smet@hotmail.com> Co-authored-by: Erwan Renaut <73958772+renauter@users.noreply.github.com> Co-authored-by: omahs <73983677+omahs@users.noreply.github.com> Co-authored-by: Lee Smet <lee.smet@hotmail.com> Co-authored-by: Rob Van Mieghem <robvanmieghem@gmail.com> Co-authored-by: Brandon <brandon@threefold.tech>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.