Documentation folder

ArnoldV · May 6, 2022 · 1777d23 · 1777d23
1 parent 3e71e9b
commit 1777d23
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 0 deletions.
diff --git a/Docs/Accessing-&-Working-with-Map-Data.md b/Docs/Accessing-&-Working-with-Map-Data.md
@@ -0,0 +1 @@
+TODO: Document Model structure, code examples etc.
diff --git a/Docs/Home.md b/Docs/Home.md
@@ -0,0 +1,3 @@
+Welcome to the Our.Umbraco.GMaps wiki!
+
+Currently these pages are placeholders for collaboration.
diff --git a/Docs/Installing-&-Configuring.md b/Docs/Installing-&-Configuring.md
@@ -0,0 +1,54 @@
+# Installing & Configuring # 
+
+
+## Installing to Your Umbraco Site
+
+### Umbraco 8
+Use NuGet to install Our.Umbraco.GMaps:  
+```powershell
+Install-Package Our.Umbraco.GMaps
+```
+Add the following keys to your web.config AppSettings node:
+
+```xml
+	<!--Google Maps Configuration-->
+	<add key="GoogleMaps:ApiKey" value="" /> <!-- Google Maps API Key -->
+	<add key="GoogleMaps:DefaultLocation" value="" /> <!-- Coordinate pair in the format lat,lng -->
+	<add key="GoogleMaps:DefaultZoom" value="17" /> <!-- Default Zoom Level for the Maps Property Editor. -->
+```
+
+
+### Umbraco 9
+Use NuGet to install Our.Umbraco.GMaps:  
+```powershell
+Install-Package Our.Umbraco.GMaps
+```
+Add the following to your appsettings.json file or equivalent settings provider (Azure KeyVault, Environment, etc.):
+
+```json
+  "GoogleMaps": {
+    "ApiKey": "",
+    "DefaultLocation": "",
+    "ZoomLevel": 17
+  }
+```
+
+## Setting Up a Data Type 
+
+In the Umbraco back-office, add a new Data Type using the **"Google Maps Single Marker"** Property Editor.
+![Back-office Data Type configuration screenshot](img/GMap_DataType_Config.png)
+
+Values set here for **Google Api Key**, **Default Coordinates**, and **Default Zoom** will override the same values configured via web.config/AppSettings.json. 
+
+
+
+## Getting a Google API Key
+
+Login to/create an account at : https://console.cloud.google.com/home/
+
+Enable the following Google Maps API on https://console.cloud.google.com/home/dashboard
+- Maps Javascript API
+- Geocoding API
+- Place API
+
+In the Credentials area, create a new API Key which allows usage of those three APIs. 
diff --git a/Docs/Rendering-&-Styling-Maps-on-the-front-end.md b/Docs/Rendering-&-Styling-Maps-on-the-front-end.md
@@ -0,0 +1 @@
+TODO
diff --git a/Docs/Troubleshooting.md b/Docs/Troubleshooting.md
@@ -0,0 +1,3 @@
+TODO: Flesh this out
+
+"This page can't load Google Maps correctly." (https://developers.google.com/maps/documentation/javascript/error-messages)
diff --git a/Docs/img/GMap_DataType_Config.png b/Docs/img/GMap_DataType_Config.png
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		TODO: Document Model structure, code examples etc.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		Welcome to the Our.Umbraco.GMaps wiki!

		Currently these pages are placeholders for collaboration.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		TODO: Flesh this out

		"This page can't load Google Maps correctly." (https://developers.google.com/maps/documentation/javascript/error-messages)