From 2bf0500fdf49daca51e9abc3838b8337ea963a4a Mon Sep 17 00:00:00 2001 From: Vesa Luusua Date: Fri, 14 Sep 2018 16:02:37 +0300 Subject: [PATCH] Remove unnecessary Google Maps refs from docs and code comments --- .env-template | 6 ++++-- docs/README.md | 2 +- docs/env.md | 3 ++- docs/folder-structure.md | 4 ++-- docs/google-maps.md | 4 ++-- src/components/SearchMap/SearchMap.js | 4 ++-- .../EditListingLocationForm/EditListingLocationForm.test.js | 2 +- .../EditListingPoliciesForm/EditListingPoliciesForm.test.js | 2 +- 8 files changed, 15 insertions(+), 12 deletions(-) diff --git a/.env-template b/.env-template index f59ad71f..8733b0e1 100644 --- a/.env-template +++ b/.env-template @@ -2,9 +2,11 @@ # Mandatory configuration # REACT_APP_SHARETRIBE_SDK_CLIENT_ID= -REACT_APP_GOOGLE_MAPS_API_KEY= -REACT_APP_MAPBOX_ACCESS_TOKEN= REACT_APP_STRIPE_PUBLISHABLE_KEY= +REACT_APP_MAPBOX_ACCESS_TOKEN= + +# Or set up an alternative map provider (Google Maps). Check documentation. +# REACT_APP_GOOGLE_MAPS_API_KEY= # Defaults # diff --git a/docs/README.md b/docs/README.md index 9f67f5d3..d67c8651 100644 --- a/docs/README.md +++ b/docs/README.md @@ -35,6 +35,7 @@ Documentation for specific topics can be found in the following files: * [Customization guide](customization-guide.md) * [Folder structure](folder-structure.md) +* [Integration to map providers](map-providers.md) * [Translations](translations.md) * [Styling a marketplace](styling.md) * [Static pages](static-pages.md) @@ -49,7 +50,6 @@ Documentation for specific topics can be found in the following files: * [Content Security Policy (CSP)](content-security-policy.md) * [Original create-react-app documentation](https://github.com/sharetribe/create-react-app/blob/master/packages/react-scripts/template/README.md) * [Customization checklist](customization-checklist.md) -* [Google Maps](google-maps.md) * [Icons](icons.md) The application was bootstrapped with a forked version of diff --git a/docs/env.md b/docs/env.md index ed7cdfec..74ed7f96 100644 --- a/docs/env.md +++ b/docs/env.md @@ -5,7 +5,8 @@ them have defaults that work for development environment. For production deploys | Variable | Description | | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| REACT_APP_GOOGLE_MAPS_API_KEY | See: [Google Maps API key](./google-maps.md) | +| REACT_APP_MAPBOX_ACCESS_TOKEN | See: [Integrating to map providers](./map-providers.md) | +| REACT_APP_GOOGLE_MAPS_API_KEY | See: [Google Maps API key](./google-maps.md) (Alternative map provider) | | REACT_APP_SHARETRIBE_SDK_CLIENT_ID | Client ID (API key). You will get this from the Sharetribe team. | | REACT_APP_STRIPE_PUBLISHABLE_KEY | Stripe publishable API key for generating tokens with Stripe API. Use test key (prefix pk*test*) for development. | | REACT_APP_SHARETRIBE_SDK_BASE_URL | The base url to access the Sharetribe Flex Marketplace API. | diff --git a/docs/folder-structure.md b/docs/folder-structure.md index 66dfe172..4e048af5 100644 --- a/docs/folder-structure.md +++ b/docs/folder-structure.md @@ -42,8 +42,8 @@ After cloning the repo, your project should look like this: ## public/index.html -This is the page template. It includes fonts, Stripe SDK, Google Maps JavaScript API, and app icons. -It also specifies placeholders for tags generated by +This is the page template. It includes fonts, Stripe SDK, Mapbox API (and Google Maps JavaScript +API), and app icons. It also specifies placeholders for tags generated by [React Helmet](https://github.com/nfl/react-helmet) ## src/ diff --git a/docs/google-maps.md b/docs/google-maps.md index d853e503..8d42ed91 100644 --- a/docs/google-maps.md +++ b/docs/google-maps.md @@ -152,8 +152,8 @@ Then, in `render` method, you need to put `SearchMapWithGoogleMap` component int props is already there in the comments: ```js -// Using Google Maps as map provider should use following component -// instead of SearchMapWithMapbox: +// When changing from default map provider to Google Maps, you should use the following +// component instead of SearchMapWithMapbox: // //