ethereum / wiki

The Ethereum Wiki
https://www.ethereum.org
14.75k stars 2.57k forks source link

Reorganize all files into folders with prior changes #573

Closed jamesray1 closed 6 years ago

jamesray1 commented 6 years ago

@pirapira

This will make the readme more visible since people don't have to scroll down a lot to get to it. As an added benefit, the repo is now more organized.

pirapira commented 6 years ago

Does this change the url of the pages?

jamesray1 commented 6 years ago

Yes, links could be updated after this change? Alternatively you could make these changes on a new branch, and make that branch the default one. Although I'm not sure whether links will then not break.

pirapira commented 6 years ago

No, I don't have control over all incoming links to the wiki.

cdetrio commented 6 years ago

Currently this repo (https://github.com/ethereum/wiki/) has two copies of the wiki: all the .md files in the repo, and the github wiki itself (https://github.com/ethereum/wiki/wiki). We should really just delete all the files in the repo (maybe leave a README with a link to the wiki), and only maintain the wiki.

EDIT: there is a note about this on the README already:

Please just edit the pages in the wiki directly as shown in the sidebar here: https://github.com/ethereum/wiki/wiki, rather than making pull requests.

jamesray1 commented 6 years ago

People will be able to figure out how to fix links by going to https://github.com/ethereum/wiki, finding the file, and changing the link.

@cdetrio, the repo has the advantage of being able to backup files as a security against vandalism, although that could also be automated, or people could just clone the wiki and set up a chron job to back it up over time and use git pull. I was the one who wrote that when I created the README. However, you do make a valid point, and perhaps the cloning, backing up and pulling can be done instead and just delete the repo except for the readme.

pirapira commented 6 years ago

@cdetrio that's amazing! Right, we don't need the filed in the repo.

@jamesray1 you can also clone the wiki pages as a git repository.

pirapira commented 6 years ago

@jamesray1 the wiki on GitHub is backed by another git repository.

jamesray1 commented 6 years ago

Yeah I've already cloned it, but it's good to know that someone else is too.

jamesray1 commented 6 years ago

Closing to replace with #575.