Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define / Discuss ways and roadmap to improve documentation #75

Open
aashish24 opened this issue Sep 8, 2016 · 3 comments
Open

Define / Discuss ways and roadmap to improve documentation #75

aashish24 opened this issue Sep 8, 2016 · 3 comments
Assignees

Comments

@aashish24
Copy link
Collaborator

  • We have lot more features now but we lack documentation for both users and developers
  • We need to have periodic review of documentation.
@mbertrand
Copy link
Collaborator

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
Copy link
Collaborator Author

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
Copy link
Collaborator

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants