An on-boarding document that NEEDS EDITING #306
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ghost
assigned 
tdooner
reviewed
Jan 23, 2019
There was a problem hiding this comment.
Hey Rich, this is a great start to #302 (I think it solidly covers the first two bullet points, and the remaining points are a bigger scope.)
I left some feedback, hope it helps. We've been needing a "Getting Started" doc for some time and I think this is a promising start.
| sudo pip install -r requirements.txt | ||
| gem install pg bundler | ||
| bundle install | ||
| ``` |
There was a problem hiding this comment.
What do you think about just directing people to the README of the backend here, rather than copying the steps? Do you think it explains the setup well enough or could it be improved?
|
|
||
| ## Making Changes / Development Process | ||
|
|
||
| Notes on our development approach and preferred coding style are written in [ :warning: ** TODO ** :warning: CONTRIBUTING.md ] |
There was a problem hiding this comment.
Seems legit, did you have a question here?
…to documentation_for_new_people
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a markdown doc I started to help with on-boarding new folks to opendisclosure. All of the information is already somewhere in the projects' 3 repos, but I tried to combine things into one doc that links all the resources I can think of so as to create "the only bookmark you'll ever need" aka "stuff I wish I knew to get started". Target audience is technically [somewhat] experienced folks that already know git/bash and want to jump into working on the codebase and issues, not a square-1 how-to-____ or list of tutorials.
Feel free to reject the pull, I just want to share what I started to help with #303 but it doesn't actually close the issue. The doc needs editing - See the
:warning: **TODO** :warning:all over the doc for things I don't know or can't answer clearly.(Also, I've created a "Documentation" folder, but obviously that should only be used if we'd expect to use it for more files in the future.)