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.

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

[Merged by Bors] - Update Lighthouse book Sec 3-6 and FAQ #4221

Closed
wants to merge 45 commits into from

Conversation

chong-he
Copy link
Member

Issue Addressed

Update Lighthouse book to include latest information especially after Capella upgrade

Proposed Changes

Notable changes:

  • Combine Sec 4.1 & 6.1 into Sec 4, because Sec 6.1 is importing validator key which is a required step when want to run a validator
  • Combine Sec 5.1 & 5.2 with Sec 5, and move Sec 5 to under Sec 9
  • Added partial withdrawals in Sec 6

Additional Info

Please provide any additional information. For example, future considerations
or information useful for reviewers.

@chong-he
Copy link
Member Author

chong-he commented Apr 25, 2023

Created another file faqV2.md which categorises the FAQs into different sections for better organisation. For review purpose, only look at faq.md is sufficient. Then, if faqV2.md looks better, can delete faq.md; otherwise if the changes to the faqV2.md is too much, can keep faq.md and delete faqv2.md.

Thanks!

Copy link
Member

@michaelsproul michaelsproul left a comment

Choose a reason for hiding this comment

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

Thanks CK!

I've reviewed almost all the changes, except the mainnet-validator.md and the FAQ. I'll come back for a 2nd review tomorrow

Maybe we can move the FAQ changes to a separate PR so this one can be merged sooner?

book/src/imgs/full-withdrawal.png Outdated Show resolved Hide resolved
book/src/imgs/partial-withdrawal.png Outdated Show resolved Hide resolved
book/src/installation.md Show resolved Hide resolved
book/src/key-management.md Outdated Show resolved Hide resolved
book/src/key-management.md Outdated Show resolved Hide resolved
book/src/voluntary-exit.md Outdated Show resolved Hide resolved
book/src/voluntary-exit.md Outdated Show resolved Hide resolved
book/src/voluntary-exit.md Outdated Show resolved Hide resolved
book/src/suggested-fee-recipient.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
@michaelsproul michaelsproul added waiting-on-author The reviewer has suggested changes and awaits thier implementation. docs Documentation v4.2.0 Q2 2023 labels May 1, 2023
chong-he and others added 11 commits May 2, 2023 21:51
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Copy link
Member

@michaelsproul michaelsproul left a comment

Choose a reason for hiding this comment

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

A few more suggestions, thanks CK!

There's also a merge conflict which we'll need to resolve before we can merge. In the git CLI you can do something like this to resolve it:

git fetch origin
git merge origin/unstable

The merge will fail and show you the files that conflict. You can then edit each one to resolve the conflicts. Github have some docs about this: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line

VSCode probably also has a nice interface for resolving conflicts

book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
book/src/mainnet-validator.md Outdated Show resolved Hide resolved
chong-he and others added 16 commits May 3, 2023 21:00
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Co-authored-by: Michael Sproul <micsproul@gmail.com>
Copy link
Member

@michaelsproul michaelsproul left a comment

Choose a reason for hiding this comment

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

Thanks CK!

@michaelsproul michaelsproul added ready-for-merge This PR is ready to merge. and removed waiting-on-author The reviewer has suggested changes and awaits thier implementation. labels May 5, 2023
@michaelsproul
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request May 5, 2023
## Issue Addressed

Update Lighthouse book to include latest information especially after Capella upgrade

## Proposed Changes

Notable changes:
- Combine Sec 4.1 & 6.1 into Sec 4, because Sec 6.1 is importing validator key which is a required step when want to run a validator
- Combine Sec 5.1 & 5.2 with Sec 5, and move Sec 5 to under Sec 9
- Added partial withdrawals in Sec 6



## Additional Info

Please provide any additional information. For example, future considerations
or information useful for reviewers.


Co-authored-by: chonghe <tanck2005@gmail.com>
@bors
Copy link

bors bot commented May 5, 2023

Pull request successfully merged into unstable.

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot changed the title Update Lighthouse book Sec 3-6 and FAQ [Merged by Bors] - Update Lighthouse book Sec 3-6 and FAQ May 5, 2023
@bors bors bot closed this May 5, 2023
ghost pushed a commit to oone-world/lighthouse that referenced this pull request Jul 13, 2023
## Issue Addressed

Update Lighthouse book to include latest information especially after Capella upgrade

## Proposed Changes

Notable changes:
- Combine Sec 4.1 & 6.1 into Sec 4, because Sec 6.1 is importing validator key which is a required step when want to run a validator
- Combine Sec 5.1 & 5.2 with Sec 5, and move Sec 5 to under Sec 9
- Added partial withdrawals in Sec 6



## Additional Info

Please provide any additional information. For example, future considerations
or information useful for reviewers.


Co-authored-by: chonghe <tanck2005@gmail.com>
Woodpile37 pushed a commit to Woodpile37/lighthouse that referenced this pull request Jan 6, 2024
## Issue Addressed

Update Lighthouse book to include latest information especially after Capella upgrade

## Proposed Changes

Notable changes:
- Combine Sec 4.1 & 6.1 into Sec 4, because Sec 6.1 is importing validator key which is a required step when want to run a validator
- Combine Sec 5.1 & 5.2 with Sec 5, and move Sec 5 to under Sec 9
- Added partial withdrawals in Sec 6



## Additional Info

Please provide any additional information. For example, future considerations
or information useful for reviewers.


Co-authored-by: chonghe <tanck2005@gmail.com>
Woodpile37 pushed a commit to Woodpile37/lighthouse that referenced this pull request Jan 6, 2024
## Issue Addressed

Update Lighthouse book to include latest information especially after Capella upgrade

## Proposed Changes

Notable changes:
- Combine Sec 4.1 & 6.1 into Sec 4, because Sec 6.1 is importing validator key which is a required step when want to run a validator
- Combine Sec 5.1 & 5.2 with Sec 5, and move Sec 5 to under Sec 9
- Added partial withdrawals in Sec 6



## Additional Info

Please provide any additional information. For example, future considerations
or information useful for reviewers.


Co-authored-by: chonghe <tanck2005@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation ready-for-merge This PR is ready to merge. v4.2.0 Q2 2023
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants