search

CityZenApp / Project-Management

Internal Repo for CityZen tasks, workflow, documentation, project management and wiki
4 stars 0 forks source link

Establish a documentation platform #8

Open rskikuli opened 6 years ago

rskikuli commented 6 years ago

As in every software we need to establish a documentation platform where all the details related to the project will be documented. First step is to do some research on the ideal platform, thatshould definitely be free open source.

rskikuli commented 6 years ago

A good article related to this issue can be found here: https://opensource.com/article/17/7/how-do-we-fix-technical-documentation-problem?sc_cid=70160000001273HAAQ.

rskikuli commented 6 years ago

What about this http://readthedocs.io/? Has anyone used it?

rskikuli commented 6 years ago

For starters I would propose to use the OSM wiki page, which I created a couple of days ago: https://wiki.openstreetmap.org/wiki/CityZen. I think it does the job for the moment. If there are no other comments @sidorelauku please add this info (the fact that the documentation wil lbe established at the before mentioned link) and once this is done I'll close this issue. The wiki page of course needs more content in terms of text and visuals.