Document developer onboarding experience and create followup issues

[olawiberg]

Test the onboarding experience and document deficiencies in current documentation and things that are missing and that can be improved.

[olawiberg]

@akshr create separate issues for these things:

• The repo does not say explicitly what the project is for, what is Ethereal doing
  • Note to Akshay: Describe requirements
• Step by step instructions missing i.e. the basics, git clone, checkout etc.
• Link to Ethereum explanations for the fullnode, miningnode etc. to explain what the nodes are doing
• More detailed instructions for what the project is about
• Explain what happens when you run compose up, explain the output and what nodes are running
• Explain what commands to see what is running and it the system is working (i.e. docker images list etc.)
• Names of the containers should reflect node type, i.e fullnode_1, mining_node_1
• How can we verify that the mining node is working
• Explain how the shared folder is used and why we are setting it up that way
• Change the order of NODE_RPC_PORT setting of environmental variable to be explained be before the attach command
• What can i do once I am connected to node-1? Explain or give examples what can be done when connected to a node
• Create an issue to Specify user and user group so that Docker images are not running as root
• It is not clear that you are not an admin user when you connect using RPC, admin API is required, explain this better.
• How do you implement sample ideas, write blog post on how to create smart contracts and test with ethereal
• Attaching using IPC is explained for how to use it with Linux when a mac user tried if will not work, should explain how to run this from the container, not the host computer. (Or how to use it using the shared mounted volume)
• Add a table of contents on the top of the documentation, make the flow of things easy to follow and jump to specific things
• Explain why a boot node is used, why is this network topology used for this network.
• The current documentation does not explain the context for why/when this can be used

Next steps:

• How to set up development environment to use Ethereal for local development
• Need a chaingaing github.io that explains the whole chaingang
• Create a command line tool that helps you create a docker-compose.yaml for specific network technology
• Test the network and write blog posts etc. for example, deploy cryptokitties contract onto ethereal network
• How would vulnerabilities such as the ones found in ERC-20 tokens (contact)

[zomglings]

Thank you @olawiberg - this is beautifully detailed!