updating CSM page, adding CSM guide, adding both to main #437
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
✅ Deploy Preview for obol-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -0,0 +1,24 @@ | |||
| --- | |||
There was a problem hiding this comment.
Why are we adding those to v1.1.1 version? I'm generally against overwriting docs version, except if it isn't for a bugfix-like thing. The idea of the versions is that they are consistent and you trust that what you see today, you will see tomorrow as well.
There was a problem hiding this comment.
Lido CSM launches tomorrow (October 25th) so I wanted to get these docs into main already now.
There was a problem hiding this comment.
Being in main doesn't strictly need to be in v1.1.1. As long as we push it to main, they are visible in the next branch in the docs.
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
Co-authored-by: Kaloyan Tanev <24719519+KaloyanTanev@users.noreply.github.com>
|
WIll give this a more detailed pass hopefully today, but getting my high level feedback in upfront. I would love if we could just have one page rather than two for this feature, and "Walkthough: Deploy a CSM DV with Linux CLI" is a long title that could probably be cleared up |
|
Okay rather than a review I just made a PR, lmk if this is reasonable https://github.com/ObolNetwork/obol-docs/pull/438/files |
OisinKyne
approved these changes
Oct 24, 2024
docs/advanced/lido_csm.md
Outdated
| @@ -6,17 +6,19 @@ description: Create a DV within Lido CSM | |||
|
|
|||
| ## Setup on Obol Launchpad | |||
|
|
|||
| For a step-by-step guide more suited to beginners, please see [here.](./lido_csm_walkthrough.md) | |||
|
|
|||
| You can use the [Obol Launchpad](../dvl/intro.md) to configure a DV for use within Lido's Community Staking Module (CSM). From within the configuration page of the launchpad: | |||
There was a problem hiding this comment.
Suggested change
| You can use the [Obol Launchpad](../dvl/intro.md) to configure a DV for use within Lido's Community Staking Module (CSM). From within the configuration page of the launchpad: | |
| You can use the [Obol Launchpad](../dvl/intro.md) to configure a DV for use within Lido's Community Staking Module (CSM). Proceed through the Launchpad flow as far as the Cluster Configuration stage: |
docs/advanced/lido_csm.md
Outdated
|
|
||
| Once all operators sign the cluster configuration, the next step is the distributed key generation. If you are not planning on operating a node, and were only configuring the cluster for the operators, your journey ends here. But if you are one of the cluster operators, continue to Step 3 of the [Quickstart](../start/quickstart_group.mdx#step-3-run-the-distributed-key-generation-dkg-ceremony) | ||
| 6. Once all operators sign the cluster configuration, the next step is the distributed key generation (DKG). |
There was a problem hiding this comment.
Suggested change
| 6. Once all operators sign the cluster configuration, the next step is the distributed key generation (DKG). | |
| 6. Once all operators agree to and sign the cluster configuration, the next step is the distributed key generation (DKG). |
docs/advanced/lido_csm.md
Outdated
|
|
||
| Once all operators sign the cluster configuration, the next step is the distributed key generation. If you are not planning on operating a node, and were only configuring the cluster for the operators, your journey ends here. But if you are one of the cluster operators, continue to Step 3 of the [Quickstart](../start/quickstart_group.mdx#step-3-run-the-distributed-key-generation-dkg-ceremony) | ||
| 6. Once all operators sign the cluster configuration, the next step is the distributed key generation (DKG). | ||
| 7. Once DKG is complete, you have the appropriate `deposit-data.json` file to upload to Lido CSM. |
There was a problem hiding this comment.
Suggested change
| 7. Once DKG is complete, you have the appropriate `deposit-data.json` file to upload to Lido CSM. | |
| 7. Once the DKG is complete, you will have the appropriate `deposit-data.json` file to upload to Lido CSM. |
|
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.
As discussed with Kody, I have updated the CSM page (which was already pushed into next) based on the google doc
https://docs.google.com/document/d/1b6FWC0uGX-nwxvVxgKgoSXR0jb3xn3Tz6Ki0CcuNgHI/edit
I also added a new page of a walkthrough guide based on Kody's gist page:
https://gist.github.com/ksale001/67944f1078a359b57bdf59365d87533a
Both of these pages need to go into main, to prepare for the launch of Lido CSM on mainnet this friday.
In the upcoming docs restructuring, these pages will not live in the "advanced" section but that's their home for now.