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

We need an examples section in the documentation #48

Open
5 tasks
timlinux opened this issue Aug 9, 2013 · 1 comment
Open
5 tasks

We need an examples section in the documentation #48

timlinux opened this issue Aug 9, 2013 · 1 comment

Comments

@timlinux
Copy link
Contributor

timlinux commented Aug 9, 2013

Problem

Even when reading the docs, projective users really don't have a good idea of what InaSAFE will produce.

Proposed solution

  • Add a new top level section called 'examples' to the docs.
  • Create a new scenarios dir in docs english static folder and create one scenario (using the save scenario tool in InaSAFE) per impact function permutation.
  • Switch to bahasa and generate the same scenarios in the id static folder
  • Use the batch runner to generate a pdf product for each scenario into the scenarios dir
  • Create an index file in rst which lists (with hyperlinks to pdfs) all the scenarios along with a short description of what each does. There should be two links for each scenario - one for map and one for table

Note: Use the scenario data from the InaSAFE data packages it has sufficient data to test all impact functions.

Expected outcome

  • Visitors to our web site will be able to browse a gallery of nice InaSAFE generated pdfs showing the outcomes of the different impact functions
  • We should be able to regenerate these pdfs automatically (or semi automatically) as we improve reporting and add new impact functions.

CC

@vanpuk
@wonderchook

@vanpuk
Copy link
Contributor

vanpuk commented Jan 8, 2014

This is a good initiative and would like to see if we are able to do this in the next month or so, I am happy to help

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

3 participants