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

Add a Process page to eips.ethereum.org #1932

Closed
wants to merge 6 commits into from
Closed

Add a Process page to eips.ethereum.org #1932

wants to merge 6 commits into from

Conversation

timbeiko
Copy link
Contributor

@timbeiko timbeiko commented Apr 10, 2019

The Ethereum Cat Herders have been trying to improve the legibility of the EIP process within Ethereum. This PR adds a Process page to eips.ethereum.org to describe the non-technical elements of the process. The contents of the page are inspired by this Ethereum Magicians thread, specifically @bmann's blog post and this tweetstorm.

index.html Outdated
@@ -7,10 +7,10 @@ <h1 class="page-heading">EIPs
<a href="https://gitter.im/ethereum/EIPs?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter"></a>
<a href="/last-call.xml"><img src="https://img.shields.io/badge/rss-Last Calls-red.svg" alt="RSS"></a>
</h1>
<p>Ethereum Improvement Proposals (EIPs) describe standards for the Ethereum platform, including core protocol specifications, client APIs, and contract standards.</p>
<p>Ethereum Improvement Proposals (EIPs) describe standards for the Ethereum platform, including core protocol specifications, client APIs, and contract standards. For more information on the EIPs process, see <a href="{{"process"|relative_url}}">Process</a> ({{site.pages|where:"type","Process"|size}}).</p>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the expression at the end for?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... I'm honestly not sure. I tried to copy the format for other links, but haven't found any info on how to build this locally to try it out. See this for a similar example: https://github.com/ethereum/EIPs/pull/1932/files/38b0bc1d5f6420c629d006ae8c0c506395052789#diff-eacf331f0ffc35d4b482f1d15a887d3bR32

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

({{site.pages|where:"type","Process"|size}}) outputs the number of pages with 'type: Process'. I don't think you need it here.

Building locally is just a matter of following the instructions for building a Github Pages Jekyll site.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Managed to build locally. Will update soon.

@timbeiko timbeiko marked this pull request as ready for review April 23, 2019 18:26
@timbeiko
Copy link
Contributor Author

Added some small changes to the Process page. I am not convinced whether this content is best as a page on eips.ethereum.org or if it should potentially be part of an existing EIP (i.e. EIP-1, EIP-233).

@nicksavers
Copy link
Contributor

@timbeiko Could you look into the build failure?

@timbeiko
Copy link
Contributor Author

@nicksavers done!

@axic
Copy link
Member

axic commented Apr 30, 2019

I think it would make sense dropping most of the content from README in this PR, otherwise there will three source for explaining the process:

  • EIP-1
  • README
  • Process paragraph on eips.ethereum.org

@timbeiko
Copy link
Contributor Author

timbeiko commented Apr 30, 2019

@axic Thank you for the feedback!

I had a previous PR merged in to make the README and the index page on eips.ethereum.org more similar. Do you think it would be reasonable to perhaps move the contents here into the README and index page instead of bringing that content over in a new page? How about having it directly in EIP-1?

@axic
Copy link
Member

axic commented Apr 30, 2019

I think any of those options are good as long as we do not have 3 sources of information 😉

My preference would probably be an overhaul of EIP-1:

  1. A chapter explaining the rules and processes.
  2. A chapter providing a guide how to apply these rules in practice.

Point 2) is what the README and this PR tries to accomplish.

@timbeiko
Copy link
Contributor Author

timbeiko commented May 3, 2019

Closing in favor of #1991

@timbeiko timbeiko closed this May 3, 2019
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

Successfully merging this pull request may close these issues.

5 participants