Update Project Documentation

hackoregon / transportation-systems

Hack Oregon Repository to develop code for the Transportation Theme of CIVIC.

MIT License

5 stars 2 forks source link

Update Project Documentation #9

Closed code-farmhouse closed 4 years ago

code-farmhouse commented 6 years ago

[x] Project Details
[ ] Timeline
[ ] Goals
[ ] Background
[ ] Partners
[ ] Tech Stack
[ ] Contact Info
[ ] API Development
[ ] Docker
[ ] PostgreSQL
[ ] Django
[ ] Data Science
[ ] CookieCutter
[ ] Exploratory Data Analysis
[ ] Models
[ ] Documentation
[ ] Contributing
[ ] ReadTheDocs
[ ] ReStructured Text vs Markdown

geophpherie commented 6 years ago

@code-farmhouse Should we only list the contact info of a few key contacts to centralize possible communication? Or would it be better to include everyone's info on that page? (I'll check with each individual regardless to see if they're okay with their info being posted.)

znmeb commented 6 years ago

@code-farmhouse How does one volunteer to "take" one of those documentation items? I think I should do the PostgreSQL one unless someone else is itching to do it, and I also want to do some documentation on the data ingestion processes and the geocoder.

geophpherie commented 6 years ago

@code-farmhouse @znmeb seems you've "taken" them right there. I don't see why they can't be yours!

znmeb commented 6 years ago

The PostgreSQL/ PostGIS / pgRouting documentation (as lecture notes) is started - see https://github.com/hackoregon/data-science-pet-containers/blob/master/docs/getting-started-with-postgresql.pdf and https://github.com/hackoregon/data-science-pet-containers/tree/master/examples.

Everything's in Markdown - I'd have to tweak the heading levels and add some more screenshots but that's about all it would take for import to Read the Docs