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

General documentation #76

Open
akhila-raju opened this issue Jul 16, 2018 · 4 comments
Open

General documentation #76

akhila-raju opened this issue Jul 16, 2018 · 4 comments
Assignees
Labels

Comments

@akhila-raju
Copy link
Contributor

@akhila-raju akhila-raju commented Jul 16, 2018

Add documentation under the Github wiki.

Documentation should include:

  • Setup and deployment models
  • Query handbook (example queries)
  • How to contribute (running tests, opening issues & PRs, etc)
  • FAQ

What else should be added?

@akhila-raju akhila-raju self-assigned this Jul 16, 2018
@akhila-raju akhila-raju added this to To do in Ongoing planning via automation Jul 16, 2018
@raulk
Copy link
Collaborator

@raulk raulk commented Jul 17, 2018

Overall this looks good to me!

I'd rename the "Setup and how to use" to "Setup and deployment models", to make it clear that ethql can be deployed in an number of ways (standalone, embedded, hosted on Infura).

"How to contribute" is super valuable.

An architecture/design section would be welcome (this one is on me!).

@raulk
Copy link
Collaborator

@raulk raulk commented Jul 17, 2018

@akhila-raju could you break this down into a task list so we can track progress individually?

Would be great if you could start working on it ASAP.

For the contribution guide, you can take inspiration from popular Github repos. Have a look at "projects with the most contributors" and "most-forked projects" here: https://octoverse.github.com/.

Another valuable source is Apache projects (Apache Ignite has a well-structured process).

Here's another one: https://gist.github.com/PurpleBooth/b24679402957c63ec426

@akhila-raju
Copy link
Contributor Author

@akhila-raju akhila-raju commented Jul 17, 2018

Sure, I'll add a task list. Already started working on it 😊

@akhila-raju
Copy link
Contributor Author

@akhila-raju akhila-raju commented Jul 20, 2018

Query handbook is done, unless there are more that should be added! 😊

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

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.