Split Set Up a Validator page in multiple pages and add improve Key Management docs #404
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
0xLucca
added
B0 - Needs Review
nhussein11
approved these changes
Feb 20, 2025
| @@ -2,5 +2,7 @@ title: Onboarding and Offboarding | |||
| nav: | |||
| - index.md | |||
| # - 'Community Validator Program': community-validator-program.md | |||
| - 'Set Up a Validator': set-up-validator.md | |||
| - 'Setup': set-up-validator.md | |||
There was a problem hiding this comment.
I think this should be "Set Up" (instead of Setup) as the title of the page is "#Set Up a Validator"
There was a problem hiding this comment.
Setup should be used if this is more of an overview. Set Up would be more appropriate for a guide. I'd probably keep it as Set Up a Validator because Set Up as a standalone title feels off 🤷♀️
| Running your validator on a test network like Westend or Kusama is a smart way to familiarize yourself with the process and identify any setup issues in a lower-stakes environment before joining the Polkadot MainNet. | ||
|
|
||
| - **Westend** - Polkadot's primary TestNet is open to anyone for testing purposes. Validator slots are intentionally limited to keep the network stable for the Polkadot release process, so it may not support as many validators at any given time | ||
| - **Kusama** - often called Polkadot's “canary network,” Kusama has real economic value but operates with a faster and more experimental approach. Running a validator here provides an experience closer to MainNet with the benefit of more frequent validation opportunities with an era time of 6 hours vs 24 hours for Polkadot |
There was a problem hiding this comment.
Suggested change
| - **Kusama** - often called Polkadot's “canary network,” Kusama has real economic value but operates with a faster and more experimental approach. Running a validator here provides an experience closer to MainNet with the benefit of more frequent validation opportunities with an era time of 6 hours vs 24 hours for Polkadot | |
| - **Kusama** - often called Polkadot's "canary network," Kusama has real economic value but operates with a faster and more experimental approach. Running a validator here provides an experience closer to MainNet with the benefit of more frequent validation opportunities with an era time of 6 hours vs 24 hours for Polkadot |
eshaben
reviewed
Feb 22, 2025
| @@ -0,0 +1,126 @@ | |||
| --- | |||
| title: Key Management | |||
There was a problem hiding this comment.
Suggested change
| title: Key Management | |
| title: Validator Key Management |
|
|
||
| ### Generate Session Keys | ||
|
|
||
| There are multiple ways to create the session keys. It can be done by interacting with the Polkadot.js Apps UI, using the curl command or by using [Subkey](https://paritytech.github.io/polkadot-sdk/master/subkey/index.html){target=\_blank}. |
There was a problem hiding this comment.
Link to Polkadot.js Apps might be nice
Comment on lines
+51
to
+53
| To properly store these keys, create a file in your keystore directory with a specific naming convention. The filename must consist of two parts: the hex string `61757261` (which represents "aura" in hex) followed by the public key without its `0x` prefix. | ||
|
|
||
| The name of the file must be the public key prepended with `61757261` (hex representation of aura) and without the 0x prefix, while the content of the file has to be the secret phrase. |
| 2. In the **Toolbox** tab, navigate to **RPC calls** | ||
| 3. Select **`author_rotateKeys`** from the drop-down menu and run the command. This will generate new session keys in your node's keystore and return the result as a hex-encoded string | ||
| 4. Copy and save this hex-encoded output for the next step | ||
|
|
There was a problem hiding this comment.
Might be nice to add an image here
| @@ -2,5 +2,7 @@ title: Onboarding and Offboarding | |||
| nav: | |||
| - index.md | |||
| # - 'Community Validator Program': community-validator-program.md | |||
| - 'Set Up a Validator': set-up-validator.md | |||
| - 'Setup': set-up-validator.md | |||
There was a problem hiding this comment.
Setup should be used if this is more of an overview. Set Up would be more appropriate for a guide. I'd probably keep it as Set Up a Validator because Set Up as a standalone title feels off 🤷♀️
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.
This PR restructures the Set Up a Validator page by splitting it into three dedicated sections:
Additionally, the Key Management section has been improved