ethereum-org-website icon indicating copy to clipboard operation
ethereum-org-website copied to clipboard

Epic: post-merge content updates

Open jmcook1186 opened this issue 3 years ago • 5 comments

Epic Description

The Merge is almost upon us. Ethereum.org has recently been updated to ensure that the content is up-to-date and correct for the final months of pre-merge Ethereum (#6281). Now, as part of our Q3 roadmap (#7166) we will create a branch of ethereum.org with content appropriate for post-merge Ethereum, with the intention to merge this branch in once The Merge is complete.

Involves

  • Scoping out what content changes, additions, or subtractions are required related to the Merge upgrade (done, tracked in Excel sheet)
  • Preparing appropriate content changes,
  • Coordinating with external contributors to ensure accuracy
  • Timing releases appropriately to provide the community with accurate information about the Merge during and immediately after transition

Goals

  • Ensure references to proof-of-work are updated to either be historical references, or removed
  • Update developer documentation to ensure all fundamentals are accurately represented under the proof-of-stake model
  • Update /upgrade/merge and to be reflective of past tense and latest information
  • Update /energy-consumption page with updated latest information

Checkpoints

Page Audit Spreadsheet

The following pages have been identified as requiring post-merge adjustments (tick off when PR merge to post-merge branch):

  • [x] /nft/ PR #7083
  • [x] /developers/docs/gas/ PR #7084
  • [x] /developers/docs/consensus-mechanisms/pow/mining/ PR #7109
  • [x] /staking/ PR #7115
  • [x] /staking/pools PR #7115
  • [x] /staking/saas PR #7115
  • [x] /staking/solo PR #7115
  • [x] /upgrades/merge/ PR #7131
  • [x] /developers/docs/web2-vs-web3/ PR #7130
  • [x] /developers/docs/consensus-mechanisms/pos/ PR ##7116
  • [x] /developers/docs/intro-to-ethereum/ PR #7141
  • [x] /developers/docs/evm/ PR #7142
  • [x] /developers/docs/evm/opcodes PR #7142
  • [x] /developers/docs/nodes-and-clients/ Open Draft PR #7133
  • [x] /learn/ updates accounted for in pre-merge epic
  • [x] /eth/ PR #7500
  • [x] /developers/docs/accounts/ PR #7252
  • [x] /developers/docs/dapps/ PR #7153
  • [x] /upgrades/beacon-chain/ PR #7266
  • [x] /developers/docs/transactions/ PR #7203
  • [x] /developers/docs/networks/ PR #7191
  • [x] /developers/docs/consensus-mechanisms/pow/ PR #7105
  • [x] /developers/docs/mev/ PR #7193
  • [x] /developers/docs/blocks/ PR #7249
  • [x] /developers/docs/consensus-mechanisms/ PR #7143
  • [x] /developers/docs/intro-to-ether/ PR #7154
  • [x] /upgrades/sharding/ PR #7499
  • [x] /glossary/ #7592
  • [x] /developers/docs/apis/json-rpc/ PR #7296
  • [x] /developers/docs/apis/backend/ PR #7297
  • [x] /energy-consumption/ PR #7076
  • [x] /security/ PR #7264
  • [x] /developers/docs/storage/ PR #7244
  • [x] /community/online/ PR #7295
  • [x] /developers/docs/apis/javascript/ PR #7297
  • [x] /upgrades/vision/ PR #7502
  • [x] /developers/docs/data-and-analytics/block-explorers/ PR #7473
  • [x] /developers/docs/nodes-and-clients/nodes-as-a-service/ PR #7480
  • [x] /developers/tutorials/uniswap-v2-annotated-code/ PR #7474
  • [x] /governance/ Suggest adding banner PR #7544
  • [x] /developers/tutorials/run-light-node-geth/ Suggest deprecation/banner PR #7544
  • [x] /developers/docs/development-networks/ PR #7487
  • [x] /developers/docs/data-and-analytics/ PR #7481
  • [x] /developers/tutorials/run-node-raspberry-pi/ Suggest deprecation/banner PR #7544
  • [x] /developers/tutorials/a-developers-guide-to-ethereum-part-one/ PR #7485
  • [x] /community/support/ PR #7478
  • [x] /developers/tutorials/hello-world-smart-contract-fullstack/ Suggest deprecation/banner PR #7544
  • [x] /developers/docs/nodes-and-clients/client-diversity/ PR #7192
  • [x] /developers/tutorials/downsizing-contracts-to-fight-the-contract-size-limit/ #7486
  • [x] /developers/tutorials/learn-foundational-ethereum-topics-with-sql/ PR #7482
  • [x] /deprecated-software/ PR #7485
  • [x] /developers/tutorials/using-websockets/ PR #7479
  • [x] /developers/docs/consensus-mechanisms/pow/mining-algorithms/ PR #7111
  • [x] /developers/docs/networking-layer/ PR #7263
  • [x] /developers/docs/consensus-mechanisms/pow/mining-algorithms/ethash PR #7112
  • [x] /upgrades/merge/issuance/ (see https://github.com/ethereum/ethereum-org-website/issues/7873) PR #7921
  • [ ] /upgrades/vision/ (rework mention of "Too much energy", see https://github.com/ethereum/ethereum-org-website/issues/7075#issuecomment-1249363740)
  • [x] /history/ (add Paris upgrade) PR #7922

jmcook1186 avatar Jul 15 '22 10:07 jmcook1186

Just noting in this commit, I anchored some content to The Merge happening in September. If it doesn't happen in September, we should fix this ASAP.

minimalsm avatar Aug 08 '22 09:08 minimalsm

FYI @jmcook1186 @wackerow updated the issue description to include the /upgrades/merge/issuance/ page.

I think(?) once that's done, we can close this issue out?

samajammin avatar Sep 16 '22 08:09 samajammin

Sounds good. A community member also reported that the Ethereum Vision page also still notes "Too much energy" as one of the problems facing Ethereum today: image

I think we should update this. Few options include:

  1. Change the title to be more broadly the issues that are being addressed, and update the description for that third card to be more of a reflection
  2. Remove this card
  3. Replace the card with a new issue that challenges the scalability of Ethereum

Open to suggestions

wackerow avatar Sep 16 '22 13:09 wackerow

A community member also reported that the Ethereum Vision page also still notes "Too much energy" as one of the problems facing Ethereum today:

Yes great point!

I'm open to any ideas. I like the idea of (1), to change the section title (maybe something like "Problems being addressed"). Then in each card description, we could link to resources on how the problem is being tackled:

  • Clogged network: mention roll-up centric roadmap & link to L2 page?
  • Disk space: linking to sharding / research resources on state expiry?
  • Energy consumption: mention this is largely solved, link to Merge/PoS page?

samajammin avatar Sep 18 '22 12:09 samajammin

A community member also reported that the Ethereum Vision page also still notes "Too much energy" as one of the problems facing Ethereum today:

i also like solution (1), maybe alongside adding a green frame to the tile and a "solved since the Merge" text going with it?

ChXmusuke avatar Sep 18 '22 14:09 ChXmusuke

Just noting that #7931 was intended to be a quick patch while planning a new approach here.

I may push back on approach 1 in the form of linking out to solutions, since the user is then more likely to leave the page when there is more to engage with below to explain more and then links out to the upgrades pages.

Would personally advocate for 3 and list another problem instead.. maybe privacy, censorship-resistance, or mev? Open to ideas. Note that we already have a callout lower in the page about the energy reduction and low-carbon output of Ethereum now.

wackerow avatar Sep 23 '22 22:09 wackerow

Hey @jmcook1186 @wackerow - is this complete? Can this be closed out?

samajammin avatar Oct 18 '22 16:10 samajammin