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

WIP: Initial website for ECIPs #12

Open
wants to merge 7 commits into
base: master
from

Conversation

Projects
None yet
4 participants
@bmann
Copy link

bmann commented Jan 15, 2019

OK, here's a first PR for #10 -- turning this repo into a Jekyll site.

GH Pages can only build from master, so I've got a preview up on Netlify: https://objective-villani-edc9c9.netlify.com/

I haven't yet gone through the list of ECIPs and added front matter. Anyone is free to do PRs into this same branch to work on this together -- https://github.com/spadebuilders/ECIPs/tree/jekyll

@bmann

This comment has been minimized.

Copy link
Author

bmann commented Jan 21, 2019

@realcodywburns @pyskell @YazzyYaz any comments / feedback on this?

Anyone with basic markdown editing / Github skills can help work on editing the ECIPs to add front matter if you've got others in the community that want to lend a hand.

@pyskell

This comment has been minimized.

Copy link
Member

pyskell commented Jan 22, 2019

@bmann Awesome stuff! Do we need to update headers on all ECIPs so this pulls data correctly? (the answer is yes)

Could this be a separate repo just to keep things uncluttered for anyone wanting to just get at ECIPs?

cc @realcodywburns We have a jekyll site being made by @bmann but will need to update ECIP headers so it can pull data correctly (or alternatively tweak the jekyll site's logic).

@bmann

This comment has been minimized.

Copy link
Author

bmann commented Jan 22, 2019

@pyskell no, it can't be a separate repo. I mean, you could do some sort of custom merge with ECIPs in a two step build process, but ideally the workflow is PRs -> merged --> build new site, which is the purpose of making this in Jekyll.

"Just get at the ECIPs" -- they are all in the ecips folder. The other thing is that I would suggest publishing an RSS/Atom feed + JSON feel that contains all the ECIPs and their status, so it can be consumed and re-mixed in different ways.

The only change is:

  • renaming of ECIPS folder to _ecips to work with default Jekyll settings
  • adding minimal YAML front matter to each ECIP, which is pretty readable as a plain Markdown document in any case

See 1010 for an example --> https://github.com/ethereumclassic/ECIPs/blob/c50dd38f623a9cbb7609065feb4844ed09ecde89/_ecips/ECIP-1010.md

@pyskell

This comment has been minimized.

Copy link
Member

pyskell commented Jan 23, 2019

@bmann Thanks for the clarifications, all sounds good to me!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment