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

create a roadmap #9

Open
another-hodler opened this issue Jul 2, 2018 · 2 comments
Open

create a roadmap #9

another-hodler opened this issue Jul 2, 2018 · 2 comments

Comments

@another-hodler
Copy link
Contributor

The relation between glacierprotocol.github.io repository and GlacierProtocol repository is not clear. It would be great to document what is the purpose and relation of these 2 repositories.

It seems to me that there is ongoing effort to move Glacier.pdf (which is Google Document originally - see GlacierProtocol/GlacierProtocol#3 (comment)) to HTML format at https://github.com/GlacierProtocol/glacierprotocol.github.io. But I didn't find this stated anywhere and therefore I am a bit confused when trying to contribute to the project:

  • should I focus on glacierprotocol.github.io primarily as it will be single point of truth in the future and the protocol documents will be generated from it or
  • do you plan to maintain glacierprotocol.org site in glacierprotocol.github.io repo and related documents in GlacierProtocol repo (and therefore not easy to contribute as there are no PR available for the Google doc)

Also there are many open issues in GlacierProtocol some of them old and easy to fix (GlacierProtocol/GlacierProtocol#2) which makes me wondering if current maintainers do have time to address them or whether they need community help. @diogomonica, @NathanMcCauley - can you please comment on this?

Thank you!

@diogomonica
Copy link
Contributor

We definitely need community help, the goal is for Glacier to no rely on a small set of contributors, and ultimately be community driven.

The website will be the way people will interact with the protocol when learning about it. The recommended way of following it offline is through a printed version of the PDF. In order to make the project more maintainable/easier to contribute to, we automated the PDF generation component and contribution to glacierprotocol.github.io will automatically be reflected in the PDF.

I hope that makes sense.

@Doweig
Copy link

Doweig commented Oct 24, 2018

Agree with @another-hodler.
How do you feel about moving all glacier.pdf related markdown from this repo to https://github.com/GlacierProtocol/GlacierProtocol?

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

3 participants