search

pacificclimate / pdp

The PCIC Data Portal - Server software to run the entire web application
GNU General Public License v3.0
1 stars 2 forks source link

Reorganize/rewrite README #118

Open jameshiebert opened 5 years ago

jameshiebert commented 5 years ago

The project README has evolved over the years along with our code base, installation methods and deployment strategies. It goes into the weeds fast, and lacks a clear overview of the (many) pieces of this project and how they all fit together.

It's time to rewrite this README from the top down to make it more coherent, understandable, and organized.

For experienced developers of this project (@corviday @rod-glover ?) I'd welcome any feedback on what parts are difficult to understand, what's easy to understand, and what you wish that you new a couple years ago when you started working on this project.

corviday commented 5 years ago

When I originally started on this project, I wasn't sure which of the several short sets of instructions applied to trying to build a development instance - I ended up combining some of the general setup instructions, some of the docker setup instructions, and some of the development instance instructions, which was not correct.

It's a lot clearer now than it was, but I think could be improved farther. Having a start to finish example development build (maybe in a separate file?), or having example builds more cleanly separated from individual components would be nice.