Skip to content

Commit

Permalink
Resolved merge conflict - used dev versions
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicklucius
nicklucius committed May 2, 2019
2 parents 8c996e3 + ffb1691 commit 0c8981b
Show file tree
Hide file tree
Showing 9 changed files with 263 additions and 253 deletions.
6 changes: 4 additions & 2 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@
Welcome to OpenGrid, an open source interactive map that allows users to explore city data in an easy to use interface. OpenGrid offers real-time or historical insights of event-based data based on time and location; whether its 311 calls, crimes, tweets, or other data sources.
</p>

<!--
This documentation provides a wide overview of OpenGrid, from how to explore data to detailed API documentation.
n-->

### Real-time and Historical Spatial Analysis
OpenGrid can be used for real-time data analysis, refreshing frequently to provide the most up-to-date information. It also allows users to reach back into time to look at past events.

### Technical Architecture

OpenGrid is designed to be flexible with different types of data sources. Whether it's MongoDB, a RESTful API, or other data sources, programmers can use [OpenGrid's API](system-administration/opengrid-api#rest-service-resources) and [Service Layer](system-administration/installation-and-setup#service-layer) to program it to work with other data sources.

### Open Source
Open source gives "OpenGrid" its name. Feel free to use it, contribute to it, or change it. Just please take a look at the project's <a href="https://github.com/Chicago/opengrid/blob/master/LICENSE.md">license</a>.

<iframe width="740" height="541" src="https://www.youtube.com/embed/pzhmbtf2Vp8" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
<iframe width="740" height="541" src="https://www.youtube.com/embed/pzhmbtf2Vp8" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
235 changes: 118 additions & 117 deletions docs/layout/launch-screen.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,126 +22,127 @@ n-->


<table>
<tr>
<th><b>Element No.</b></th>
<th><b>Element Name/Description</b></th>
</tr>
<tr>
<td>
1.
</td>
<td>
Quick Search box is used to perform basic searches on datasets. The question mark icon within the Quick Search box displays a cheat sheet for quick search syntax.
</td>
</tr>
<tr>
<td>
2.
</td>
<td>
<ul>
<li>Find Data Button displays the advanced search panel utilize to create more defined searches.</li>
<li>Clear Data Button, resets the map.</li>
</ul>
</td>
</tr>
<tr>
<td>
3.
</td>
<td>
User Manual Link
<ul>
<li>Link to accessing the OpenGrid user manual.</li>
</ul>
</td>
</tr>
<tr>
<td>
4.
</td>
<td>
Zoom In and Zoom Out Icon &nbsp; <img alt src ="../../media/image34.jpg">
</td>
</tr>
<tr>
<td>
5.
</td>
<td>
Reset Map View and Area Zoom Icon &nbsp; <img alt src="../../media/rest.jpg">
</td>
<tr>
<th><b> Element No.</b></th>
<th><b>Element Name/Description</b></th>
</tr>
<tr>
<td>
1.
</td>
<td>
Quick Search box is used to perform basic searches on datasets. The question mark icon within the Quick Search box displays a cheat sheet for quick search syntax.
</td>
</tr>
<tr>
<td>
6.
</td>
<td>
Zoom Specification Icon <img alt src="../../media/image37.jpg">
<br> <br>
Full-Screen Icon <img alt src="../../media/image38.jpg">
<br> <br>
Geo-Location Icon <img alt src="../../media/image36.jpg">
</td>
</tr>
<tr>
<td>
7.
</td>
<td>
Measurement &nbsp; <img alt src="../../media/Measure.jpg">
</td>
</tr>
<tr>
<td>
8.
</td>
<td>
Layers Icon &nbsp; <img alt src="../../media/image39.jpg">
<br>
Consist of list of grid views and weather layers.
<br>
<b>Base Layers Views:</b>
<ul> <ul> <ul>
<li>Street View (Default)</li>
<li>Aerial View</li>
<li>Black and White View</li>
</ul></ul></ul>
<b>Open Weather Layers:</b>
<ul> <ul> <ul>
<li>Cloud Cover</li>
<li>Quantity of Precipitation</li>
<li>Sea Level Pressure</li>
<li>Temperature</li>
</ul></ul></ul>
</td>
</tr>
<tr>
<td>
9.
</td>
<td>
Expandable Table View Panel
</td>
</tr>
<tr>
<td>
10.
</td>
<td>
Map attribution; display's a link for any copyright information, terms of usage, etc.
</td>
</tr>
<tr>
<td>
11.
</td>
<td>
Main Map Display
</td>
</tr>
<td>
2.
</td>
<td>
<ul>
<li>Find Data Button displays the advanced search panel utilize to create more defined searches.</li>
<li>Clear Data Button, resets the map.</li>
</ul>
</td>
</tr>
<tr>
<td>
3.
</td>
<td>
User Manual Link
<ul>
<li>Link to accessing the OpenGrid user manual.</li>
</ul>
</td>
</tr>
<tr>
<td>
4.
</td>
<td>
Zoom In and Zoom Out Icon <img alt src = ".././media/image34.jpg">
</td>
</tr>
<tr>
<td>
5.
</td>
<td>
Reset Map View and Area Zoom Icon <img alt src=".././media/rest.jpg">
</td>
</tr>
<tr>
<td>
6.
</td>
<td>
Zoom Specification Icon <img alt src=".././media/image37.jpg">
<br> <br>
Full-Screen Icon <img alt src=".././media/image38.jpg">
<br> <br>
Geo-Location Icon <img alt src=".././media/image36.jpg">
</td>
</tr>
<tr>
<td>
7.
</td>
<td>
Measurement Tool <img alt src=".././media/Measure.jpg">
</td>
</tr>
<tr>
<td>
8.
</td>
<td>
Layers Icon <img alt src=".././media/image39.jpg">
<br>
Consist of list of grid views and weather layers.
<br>
<b>Base Layers Views:</b>
<ul> <ul> <ul>
<li>Street View (Default)</li>
<li>Aerial View</li>
<li>Black and White View</li>
</ul></ul></ul>
<b>Open Weather Layers:</b>
<ul> <ul> <ul>
<li>Cloud Cover</li>
<li>Quantity of Precipitation</li>
<li>Sea Level Pressure</li>
<li>Temperature</li>
</ul></ul></ul>
</td>
</tr>
<tr>
<td>
9.
</td>
<td>
Expandable Table View Panel
</td>
</tr>
<tr>
<td>
10.
</td>
<td>
Map attribution; display's a link for any copyright information, terms of usage, etc.
</td>
</tr>
<tr>
<td>
11.
</td>
<td>
Main Map Display
</td>
</tr>
</table>

<br>

## Map/Base Layers

Expand Down Expand Up @@ -180,4 +181,4 @@ map. Using navigational controls, the user will be able to:

- apply measurements

- select hyperlinks
- select hyperlinks
Binary file modified docs/media/Thumbs.db
View file
Binary file not shown.
61 changes: 29 additions & 32 deletions mkdocs.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,42 +7,39 @@ repo_url: https://github.com/Chicago/opengrid
theme: readthedocs

pages:
- 'Home': 'index.md'
- Home: index.md
#- User Guide:
# - End-user documentation: User Documentation.md
- 'OpenGrid Layout': 'layout/launch-screen.md'
- 'Table Grid': 'layout/table-grid.md'
- 'Quick Search': 'quick-search/quick-search.md'
- 'Finding Data':
- 'Getting Started': 'finding-data/getting-started.md'
- 'Advanced Filtering': 'finding-data/advanced-filtering.md'
- 'Automatically Refresh Searches': 'finding-data/auto-refresh-search.md'
- 'Commonly Used Queries': 'finding-data/commonly-used-queries.md'
- 'Searching With Relative Time': 'finding-data/relative-time-searches.md'
- 'Search by Location':
- 'Within An Area': 'search-location/within-geospatial-filter.md'
- 'Near A Location': 'search-location/near-geospatial-filter.md'
- 'Customize the Look': 'customize-look/index.md'
- 'Charts and Heatmaps':
- 'Heatmaps': 'charts-heatmaps/heatmaps.md'
- 'Tile map': 'charts-heatmaps/tile-map.md'
- 'Map Layers': 'map-layers/index.md'
- 'Measure Distance': 'measure-distances/index.md'
- OpenGrid Layout:
- Launch Screen: layout/launch-screen.md
- Table Grid: layout/table-grid.md
- Finding Data:
- Getting Started: finding-data/getting-started.md
- Advanced Filtering: finding-data/advanced-filtering.md
- Automatically Refresh Searches: finding-data/auto-refresh-search.md
- Commonly Used Queries: finding-data/commonly-used-queries.md
- Searching With Relative Time: finding-data/relative-time-searches.md
- Search by Location:
- Within An Area: search-location/within-geospatial-filter.md
- Near A Location: search-location/near-geospatial-filter.md
- Customize the Look: customize-look/index.md
- Charts and Heatmaps:
- Heatmaps: charts-heatmaps/heatmaps.md
- Tile map: charts-heatmaps/tile-map.md
- Map Layers: map-layers/index.md
- Measure Distance: measure-distances/index.md
#- Developers:
# - API: opengrid-api.md
- 'System Administration':
- 'API': 'system-administration/opengrid-api.md'
- 'App Architecture': 'system-administration/architecture.md'
- 'Installation and Setup': 'system-administration/installation-and-setup.md'
- 'Build Procedures': 'system-administration/build-procedures.md'
- 'Configuration': 'system-administration/opengrid-configuration.md'

extra:
collapse_toc: true
- System Administration:
- API: system-administration/opengrid-api.md
- App Architecture: system-administration/architecture.md
- Installation and Setup: system-administration/installation-and-setup.md
- Build Procedures: system-administration/build-procedures.md
- Configuration: system-administration/opengrid-configuration.md

markdown_extensions:
- toc:
permalink:
- admonition:
- toc:
permalink:
- admonition:

copyright: Copyright &copy; 2015-2016 <a href="http://www.cityofchicago.org">City of Chicago</a> and licensed under <a href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International</a>.
copyright: Copyright &copy; 2015-2016 <a href="http://www.cityofchicago.org">City of Chicago</a> and licensed under <a href="http://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International</a>.
Loading

0 comments on commit 0c8981b

Please sign in to comment.