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

Restructure and Write Further Content in Eth2 Book #7

Open
villanuevawill opened this issue Feb 12, 2020 · 6 comments
Open

Restructure and Write Further Content in Eth2 Book #7

villanuevawill opened this issue Feb 12, 2020 · 6 comments

Comments

@villanuevawill
Copy link
Contributor

Review Process

Develop a review process for both internal and external reviewers. Initial feedback should direct the content and help iterate the book. A "Guide for Reviewers" should be created that helps contributors get familiar with the project, its goals, and requested areas of feedback. The GitHub repository should now include a detailed project board to help manage the status of content within the book. Individual pages should have indicators to give reviewers additional context about the status of a particular draft.

Content Restructure

Based on early feedback, a large portion of the initial book structure should be changed. The project should go into much more detail about the origins of Eth2 and the fundamentals of consensus mechanism design. New sections should vastly simplify the flow of the book and remove many of the assumptions made about the knowledge of the reader.

Proof of Stake Content

We should create strong drafts of content regarding the Eth2 Proof of Stake protocol. Most of the initial content should be reworked. The discussion should now present a more intuitive explanation of the protocol and illuminate the problem-solution reasoning behind its design. Reworked content should be available on the staging site.

Eth1/Eth2 Overview Content

Overviews of Eth1 and Eth2 should be published as drafts on the staging site. These are largely in flux, but present a good starting point for future work. Feedback about these drafts should help inform the decision to include more study into consensus mechanism basics. We should create an early draft for the sections about consensus (likely to become its own chapter) and should have them published in the near future. Overall, we should now be much more confident about the direction of the book based on responses to the first drafts.

Contribution Process

External contributions are extremely valuable, particularly given the amount of "tribal knowledge" in the Eth2 space. We should settle on a process for these contributions, and reach out to potential contributors individually. Part of this process includes a new "Eth2 Journal" site as to begin collecting content as quickly as possible. Development on this new site should began as of this week.

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


This issue now has a funding of 23.5 ETH (6000.09 USD @ $255.32/ETH) attached to it.

@developerfred
Copy link

Hi @villanuevawill!, how can i work on that bounty?

@smartcontracts
Copy link

Goal fulfillment:

Review Process

Our review process was codified in a guide for potential reviews. It includes information about the project, the method for leaving review comments, and area's on which we're looking for review. So far it's worked out quite well.

Content Restructure

We had some major content restructuring as per feedback about initial drafts. Early sections of the book were reworked to give a more detailed overview of consensus mechanisms and blockchains as a whole before moving into Eth1 specifics. Draft content for this restructure is ready to be published, waiting to finish a few more drafts before pushing (likely later today).

Proof of Stake Content

We completely rewrote most of the Proof of Stake content to reflect feedback. It now generally explains the Eth2 PoS protocol as a series of solutions to concrete problems, instead of simply the solutions on their own. New drafts are available on our staging site.

Eth1/Eth2 Overview Content

Much of the early Eth1 overview content was reworked into a new chapter dedicated to the concept of blockchains. Although not yet complete, we've added detailed outlines for each of the sections within this chapter for anyone looking to get a feel for the content to come. Eth2 overview is currently available on the staging site, but will likely be reworked within the coming week.

Contribution Process

We've decided on a contribution process with some feedback from potential reviewers. We're in the process of putting together an Eth2 "journal" as a was to more immediately pull in content from external contributors. A full contribution guide should be available within the next week.

@gitcoinbot
Copy link

gitcoinbot commented Feb 21, 2020

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 4 weeks from now.
Please review their action plans below:

1) kfichter has started work.

​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
2) kfichter has started work.

​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​

Learn more on the Gitcoin Issue Details page.

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work has been started.

These users each claimed they can complete the work by 4 weeks from now.
Please review their action plans below:

1) kfichter has started work.

​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​

Learn more on the Gitcoin Issue Details page.

@gitcoinbot
Copy link

Issue Status: 1. Open 2. Started 3. Submitted 4. Done


Work for 23.5 ETH (6214.45 USD @ $264.44/ETH) has been submitted by:

  1. @kfichter

@villanuevawill please take a look at the submitted work:


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants