Documentation Table of Contents

Below is a working outline of the OpenGrid documentation. The documentation will discuss end-user operations (e.g., how to conduct a query), administrators (e.g., how to install, how to add users), and developers (e.g., documenting the API).

Documentation will be written in Markdown and placed in the docs/ folder. Documentation will be rendered in ReadTheDocs with the following table of contents:

• User Documentation
  • Getting Started
    • Supported browsers
  • Quick Search
    • Find an address
    • Find a point-of-interest
    • Quick search data
  • Advanced Search
    • Selecting data and time range
    • Search around a point
    • Drawing boundaries
    • Monitoring queries
  • Exporting data and saving maps
  • Graphing results
  • Creating tile (choropleth) and heat maps
  • Saving and sharing queries
  • Measure distance and area
  • FAQ
• Installation and setup
  • Overview
    • Technical requirements
  • Installation
    • User interface
    • Service Layer
      • MongoDB
  • Database Configuration
    • MongoDB
• Administration
  • Overview
  • User Management
    • Adding users
    • Setting-up groups
    • Customizing session time-out
  • Data Sources
    • Adding new data source
• Developer Documentation
  • System Architecture
  • Service Layer API
  • Unit testing