Define / Discuss ways and roadmap to improve documentation

OpenDataAnalytics / gaia

Gaia is a geospatial analysis library jointly developed by Kitware and Epidemico.

31 stars 15 forks source link

Define / Discuss ways and roadmap to improve documentation #75

Open aashish24 opened 8 years ago

aashish24 commented 8 years ago

We have lot more features now but we lack documentation for both users and developers
We need to have periodic review of documentation.

mbertrand commented 8 years ago

There is a plugin page on readthedocs that includes documentation for developers on creating new plugins: http://gaia.readthedocs.io/en/latest/plugins.html

Also includes a list of 'official' plugins with links to their respective readthedocs pages; currently just spatialstats and twitter, I will add the newest ones today (density-computations, least-cost-path). http://gaia.readthedocs.io/en/latest/plugins.html#official-gaia-plugins

aashish24 commented 8 years ago

thanks @mbertrand my intent was to improve the text mostly as part of this issue: For example, if you read the description of this plugin, it feels incomplete:

Gaia SpatialStats Plugin This is a plugin for Gaia (https://github.com/OpenDataAnalytics/gaia) that provides spatial statistics processes using PySAL, including:

What I am thinking that we provide some 1-2 para on each plugin, describe a use-case, and potentially attach a image that shows the result of the analysis.

mbertrand commented 8 years ago

@essamjoubori and @chuehlien could you work on expanding the documentation as @aashish24 suggests above for the plugins you've worked on (Julie - spatial stats, Essam - least-cost-path, density computations, twitter)? I will do the same for the core gaia processes.