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

Turn EIPs repository into a Github Pages / Jekyll site #940

Merged
merged 28 commits into from
Mar 21, 2018

Conversation

Arachnid
Copy link
Contributor

This PR restructures the EIPs repository so merged EIPs can be parsed as Jekyll documents, and adds structure and configuration to render it as such. A preview of the generated site can be seen here.

Changes to the already-committed EIPs:

  • Add '---' on lines before and after the header data for each EIP, making them valid YAML prologues.
  • Change header names to be lower case.
  • Standardise names and values in EIPs that did not match conventions described by EIP-1.

In addition, this PR includes a few changes to EIP-1:

  • Changing header names to match the changes made to each EIP.
  • Incorporating new header entries that were specified in the template but not EIP-1.
  • Adding the requirement for '---' either side of header entries.

The template eip-X has also been updated to reflect these changes.

Next steps (after this PR):

  • Set up a CNAME for eips.ethereum.org
  • Link to the new page from the README, and direct people there for reference and for canonical URLs.
  • Add travis build to automatically check PRs for validity.
  • Open discussion about changes to the EIP draft/merge/update process.

@Arachnid Arachnid requested a review from Souptacular March 21, 2018 17:39
Copy link
Contributor

@Souptacular Souptacular left a comment

Choose a reason for hiding this comment

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

Great stuff!

@Arachnid Arachnid merged commit 984cf5d into ethereum:master Mar 21, 2018
@nicksavers nicksavers mentioned this pull request Mar 21, 2018
@jamesray1
Copy link
Contributor

jamesray1 commented Mar 22, 2018

The link to the preview generated site, http://arachnid.github.io/EIPs/, gives a 404. Other than that this looks good!

@Arachnid
Copy link
Contributor Author

@jamesray1 Should be fixed now, though I'll take it down again once it's up and running on its permanent URL.

@tjayrush
Copy link

Excellent. Categorize this as an Ethereum Improvement Proposal that helps everyone better understand what's going on.

@jamesray1
Copy link
Contributor

@Arachnid awesome, the preview looks great!

@jamesray1
Copy link
Contributor

Oh, the link to the template EIP doesn't work.

http://arachnid.github.io/EIPs/

https://github.com/ethereum/EIPs/blob/master/eip-X

@jamesray1
Copy link
Contributor

jamesray1 commented Mar 22, 2018

It needs to have .md on the end of it; this works:
https://github.com/ethereum/EIPs/blob/master/eip-X.md.

@Arachnid
Copy link
Contributor Author

@jamesray1 Fixed in my outstanding PR, thanks for spotting it.

@jamesray1
Copy link
Contributor

You're welcome Nick!

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.

7 participants