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

Organize Docs #238

Closed nikola-rados closed 3 years ago

nikola-rados commented 3 years ago

Changes

I wanted to help organize all the helpful information we have in the pdp. I felt that we would benefit from moving most of it into a dedicated /docs directory. I am open to any suggestions on restructuring or reorganizing this, so please let me know!

Resolves #237

Checklist

nikola-rados commented 3 years ago
  1. Ya I sort of assumed a lot of it would be out the window but at least the format is better.
  2. Great idea, that would help alleviate some of the work the table of contents has to do.
  3. Agreed, more links in the README would be better.
  4. Understood.
  5. I did it manually. It helped to break up the sections a bit but if we breakdown the readme into several files it should make it the numbers redundant.
nikola-rados commented 3 years ago

@corviday and @rod-glover I have made some changes based on your feedback. I think we definitely need a content overhaul but since things are changing so soon we should try and avoid changing it twice. Furthermore, I've been looking into pipenv to replace some of the installation tools we have here (mainly tox since it never works) and that will have a big impact on the documentation.