Organize docs #10
Merged
Organize docs #10
Conversation
This file contains hidden or 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
thatandromeda
force-pushed
the
64_organize_docs
branch
from
b834101 to
96de50b
Compare
gravesm
approved these changes
Feb 6, 2018
docs/developer.md
Outdated
| You only need the first three of these if you plan to be doing neural net training. If you're developing the Django parts you can skip them; just get a prebuilt neural net file (see below, "Neural net files"). | ||
|
|
||
| ### Other config | ||
| Postgres needs a database and user (default values are `hamlet` for database name and username, no password; override this if desired in `.env` with `DJANGO_DB`, `DJANGO_DB_USER`, `DJANGO_DB_PASSWORD`) |
Collaborator
There was a problem hiding this comment.
One suggestion would be to also add the ENGINE setting to .env. I'm actually running things locally with sqlite since it's easier to set up in dev. I'm running things with a custom setting file in order to do this, but would be nice to be able to skip that and put the config in .env.
Owner
Author
There was a problem hiding this comment.
Good idea; done and documented.
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.
I've made our docs more generally organized (separating dev and sysadmin docs, using complete sentences, stuff like that). As the person who has most recently needed project documentation, can you have a look and tell me if there are glaring omissions or inaccuracies? No need for in-depth wordsmithing - just want to put the docs on a more responsible footing.