-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Migrate materials from eth.wiki #5690
Comments
Awesome, thanks for digging into this! Looking through some of you specific page recommendations...
Is this something all clients still do? Should we perhaps add a section within https://ethereum.org/en/developers/docs/nodes-and-clients/ that touches on this, so people are aware it exists? I can also see your point that we could leave that to each client team to document on their own. It does seem a bit of an advanced topic to cover. In that case, what should we do with this page?. We should still redirect it somewhere if we're going to kill it. I'd say https://ethereum.org/en/developers/docs/nodes-and-clients/ is better than nothing. A general note I'd say is that we should try to avoid sunsetting a page but not redirecting it anywhere (i.e. don't break the internet). We should at least try to redirect to the most relevant page so users have the best chance to eventually find what they're looking for. ...that's all I have time for now 😅 I'll try to circle back this week to review the rest! |
ok! I can certainly add a note to the existing nodes and clients page that can then be linked out to. Will update table accordingly. Update: added client string info to /nodes-and-clients/run-a-node/ that can act as redirection target for this page: PR #5996 |
This comment was marked as spam.
This comment was marked as spam.
@jmcook1186 I think we can close this out - great work! Feel free to re-open if you think we missed anything. |
Reporting that I receive a 404 from the eth.wiki page https://eth.wiki/fundamentals/rlp which was the top search result in "RLP_encode" and "recursive length prefix". I don't think a mapping to each old eth.wiki to ethereum.org docs is feasible but a catch-all redirect to https://ethereum.org or https://ethereum.org/en/developers/docs/ might make sense |
Background
The material hosted at eth.wiki is now very stale and contains information that is years out of date. This can be confusing for users because the old information can contradict newer information available elsewhere and it is not clear what the canonical source of information should be. While the wiki is rich with Ethereum history, it seems like a good time to migrate some information from those sites onto ethereum.org and sunset those older sites.
There have been several suggestions along similar lines recently but so far only relatively minor actions have been taken, e.g.
ethereum/eth-wiki#55
Therefore, I'm raising this issue to jump-start progress on this and get the good content from the wiki migrated over to ethereum.org.
Proposal
I have been through the wiki page by page and made suggestions for which materials I think should be migrated to ethereum.org and which materials should be archived/taken offline. Below is a table with those file-by-file suggestions. Underneath the table is a high level summary of the actions that could be taken int he form of 12 PRs to ethereum.org to preserve the good information currently only available in the wiki.
Actions
The following 12 items are materials either present in the wiki and absent on ethereum.org, or explained in much more detail on the wiki that I suggest could be incorporated into ethereum.org. Suggest each one could be tacked as a separate PR:
UPDATE: ADDRESSED BY PR migrate info on pow-mining from ethdocs and eth.wiki #5897
The wiki could then be sunsetted by redirecting to appropriate pages on ethereum.org or external sites.
After discussion with the ethereum.org team, materials related to Swarm and ENS are best redirected to their individual sites rather than migrating the information onto ethereum.org.
Linked issues
The text was updated successfully, but these errors were encountered: