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

Integrate kb.beaconcha.in content #2277

Closed
samajammin opened this issue Jan 19, 2021 · 11 comments
Closed

Integrate kb.beaconcha.in content #2277

samajammin opened this issue Jan 19, 2021 · 11 comments
Assignees
Labels
content 🖋️ This involves copy additions or edits feature ✨ This is enhancing something existing or creating something new good first issue Good item to try if you're new to contributing

Comments

@samajammin
Copy link
Member

samajammin commented Jan 19, 2021

Is your feature request related to a problem? Please describe.

The folks at beaconcha.in have built out some incredible technical resources on Eth2:
https://kb.beaconcha.in/

The content is open source & free to use:
https://github.com/gobitfly/eth2-knowledge-base/blob/master/LICENSE

Chatted with @Buttaa & confirmed that we're welcome to add their resources on the site. As always, we should link out to them w/ credit as the original source.

Describe the solution you'd like

We should discuss & decide the best place for this content. 2 main options

  1. Within the Eth2 section: https://ethereum.org/en/eth2/
  2. Within the developer docs section: https://ethereum.org/en/developers/docs/

Curious to hear what folks think. My take: given their technical focus & that eventually, "Eth2" resources will eventually become just "Ethereum" dev resources, I learn toward putting them within the developer docs. On the side navigation we currently have an "Advanced" section. We could store them there or create a new "Eth2" section.

Describe alternatives you've considered
Just link out to kb.beaconcha.in pages where appropriate

Context

Part of this epic: #7075

@samajammin samajammin added feature ✨ This is enhancing something existing or creating something new content 🖋️ This involves copy additions or edits labels Jan 19, 2021
@samajammin
Copy link
Member Author

Some thoughts on specific pages:

Pages I'm not sure about:

@wackerow wackerow self-assigned this Jan 19, 2021
@Buttaa
Copy link
Contributor

Buttaa commented Jan 20, 2021

Hi @samajammin ,

here are additional ideas which I did not have time for yet

  • How rewards work
  • improving inclusion delays
  • explain port forwarding + practical example
  • key managment
  • how to handle extreme scenarios (electricity/internet outage)

The reason I added

https://kb.beaconcha.in/depositing-to-ethereum-2.0 (should we just refer folks to https://launchpad.ethereum.org/)

this way was because users wanted to know and see how to deposit independently to the contract without using a central service like the launchpad :) It is outdated though, because prysm has changed their client since then.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 7, 2021

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Mar 7, 2021
@wackerow wackerow removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Mar 9, 2021
@ryancreatescopy
Copy link
Contributor

My take: given their technical focus & that eventually, "Eth2" resources will eventually become just "Ethereum" dev resources, I learn toward putting them within the developer docs. On the side navigation we currently have an "Advanced" section. We could store them there or create a new "Eth2" section.

For this very reason, I think we should integrate these as much as possible into existing sections. Make sure we have clear ETH2 sections within pages where relevant. I don't think we should create an ETH2 bucket, instead integrate into existing sections wherever possible.

@samajammin samajammin added the good first issue Good item to try if you're new to contributing label Mar 30, 2021
@github-actions
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label May 14, 2021
@wackerow wackerow removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label May 14, 2021
@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jun 29, 2021
@github-actions github-actions bot closed this as completed Jul 6, 2021
@samajammin samajammin removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jul 27, 2021
@samajammin samajammin reopened this Jul 27, 2021
@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Sep 11, 2021
@minimalsm minimalsm removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Sep 28, 2021
@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Nov 18, 2021
@minimalsm minimalsm removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Nov 18, 2021
@ethereum ethereum deleted a comment from github-actions bot Nov 18, 2021
@ethereum ethereum deleted a comment from github-actions bot Nov 18, 2021
@ethereum ethereum deleted a comment from github-actions bot Nov 18, 2021
@minimalsm
Copy link
Contributor

Re-up this?

@samajammin
Copy link
Member Author

Latest thinking on this - maybe we should create a staking "docs" section under the main staking page:
https://ethereum.org/en/staking/

We could use the same docs.js markdown template we use for the developer docs:
https://ethereum.org/en/developers/docs/

Reasoning is that these resources should probably be kept separate from the developer docs… we don’t want to intimidate folks by making them feel they need to be a developer in order to be technical enough to stake.

@github-actions
Copy link
Contributor

This issue is stale because it has been open 45 days with no activity.

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Apr 22, 2022
@samajammin samajammin removed the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jul 18, 2022
@samajammin
Copy link
Member Author

@jmcook1186 assigning to you as well 😄 - feel free to update this issue/description as needed.

@jmcook1186
Copy link
Contributor

jmcook1186 commented Jul 19, 2022

Reviving this post as part of the merge-update epic #7075

Suggest modifying (mostly just adding front-matter and minor content tweaks such as removing Eth 2 terminology) and migrating the following pages into developers/docs/consensus-mechanisms/pos. Please add PR link next to page when raised, and tick checkbox when merged.

Would also be good to add new pages on:

  • block proposal
  • ...

@samajammin @wackerow @minimalsm

@wackerow
Copy link
Member

Calling this complete with the merging of our post-merge content. 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits feature ✨ This is enhancing something existing or creating something new good first issue Good item to try if you're new to contributing
Projects
None yet
Development

No branches or pull requests

6 participants