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

Documentation request: describe and link to documentation for the tech stack + related CRHQ projects #109

Open
EMCain opened this issue Nov 3, 2017 · 2 comments

Comments

@EMCain
Copy link

EMCain commented Nov 3, 2017

It would be good to write a section in the README listing the various packages and technologies this relies on, to the extent that people need to understand them, with a short description of how each is used, and links to documentation for them. Also, describing any other CRHQ projects it interacts with, and external APIs.

I can work on writing this, but I will need help with some parts.

@ArtOfCode-
Copy link
Owner

All yours, Emily :) Ping the usual suspects in Slack if you need info; the thing currently on the top of my head is that it will help to have a good understanding of MySQL and RDB concepts in general.

@thesecretmaster
Copy link
Collaborator

Also, feel free to make a PR. If you do, I can help write bits.

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

No branches or pull requests

3 participants