document custom API URL & add Info.plist guide #6833

incanus · 2016-10-26T17:03:06Z

Updated nullability and documented MGLMapboxAPIBaseURL key in Info.plist.

mention-bot · 2016-10-26T17:03:07Z

@incanus, thanks for your PR! By analyzing the history of the files in this pull request, we identified @bleege, @1ec5 and @friedbunny to be potential reviewers.

1ec5 · 2016-10-26T17:33:28Z

This documentation won't be visible to the public. While you're at it, can you document our Info.plist keys in a jazzy guide? See realm/jazzy#523.

incanus · 2016-10-26T17:53:30Z

This documentation won't be visible to the public.

Right, that's fine. This is under-the-radar enough that folks can pick it up from the changelog, if at all. The docs are more for us.

can you document our Info.plist keys in a jazzy guide?

Not sure I follow. Where would this show up?

1ec5 · 2016-10-26T17:59:11Z

A guide would be a separate document, listed in the jazzy docs' table of contents. Like the readme, it would be written in Markdown.

incanus · 2016-10-26T18:39:02Z

Ok, got the guides in 0964964. Tried a combined darwin file at first, but macOS doesn't have the opt-out key so had to do separate ones. The section name is tied to the filename, hence the space. This looks pretty good. I don't think we need to mention [Apple's] Core Location keys around location permissions.

1ec5

Thanks for starting our first jazzy guide! I like the direction this is headed.

1ec5 · 2016-10-26T19:17:51Z

platform/ios/Info.plist Keys.md

+
+## MGLMapboxAccessToken
+
+Use this key to set your Mapbox API [access token](https://www.mapbox.com/help/define-access-token/). This key is required for all map use. 


This would be a good place to consolidate the explanation that’s currently in +[MGLAccessToken setAccessToken:] and MGLMapView. Actually, since a link back to this document won’t work in Quick Help, duplicating that explanation would be preferable.

1ec5 · 2016-10-26T19:18:30Z

platform/ios/Info.plist Keys.md

+
+## MGLMapboxAPIBaseURL
+
+Use this key if you need to customize the API base URL used throughout the SDK. If unset, the default Mapbox API is used. 


An example would be nice (even the default value). Otherwise, the developer has no idea whether to include the scheme, a trailing slash, etc.

1ec5 · 2016-10-26T19:20:17Z

platform/ios/Info.plist Keys.md

+
+## MGLMapboxAccessToken
+
+Use this key to set your Mapbox API [access token](https://www.mapbox.com/help/define-access-token/). This key is required for all map use. 


Also link to +[MGLAccountManager setAccessToken:] as an alternative for developers who prefer to set their access token in code, as well as this guide for those who want to keep their access token super private.

1ec5 · 2016-10-26T22:07:05Z

platform/ios/Info.plist Keys.md

+
+## MGLMapboxAccessToken
+
+Set the <a href="https://www.mapbox.com/help/define-access-token/">Mapbox access token</a> to be used by all instances of `MGLMapView` in the current application.


Nit: use Markdown link syntax.

1ec5 · 2016-10-26T22:09:09Z

platform/ios/scripts/document.sh

@@ -38,6 +38,7 @@ jazzy \
 --github-file-prefix https://github.com/mapbox/mapbox-gl-native/tree/${BRANCH} \
 --module-version ${SHORT_VERSION} \
 --readme ${README} \
+ --documentation="platform/ios/Info.plist Keys.md" \


Please move to platform/ios/docs/ to live alongside doc-README.md.

friedbunny · 2016-10-26T22:06:51Z

platform/ios/CHANGELOG.md

@@ -62,6 +62,7 @@ Mapbox welcomes participation and contributions from everyone. Please read [CONT
 * Fixed a crash that occurred when encountering a rate-limit error in response to a network request. ([#6223](https://github.com/mapbox/mapbox-gl-native/pull/6223))
 * Fixed an issue causing an MGLOfflinePack’s progress to continue to update after calling `-suspend`. ([#6186](https://github.com/mapbox/mapbox-gl-native/pull/6186))
 * Fixed an issue preventing cached annotation images from displaying while the device is offline. ([#6358](https://github.com/mapbox/mapbox-gl-native/pull/6358))
+* Added support for an `MGLMapboxAPIBaseURL` key in an app's `Info.plist` in order to customize the base URL used for retrieving map data, styles, and other resources. ([#6709](https://github.com/mapbox/mapbox-gl-native/pull/6709))


Extra space: key in

friedbunny · 2016-10-26T22:29:07Z

Currently looks like:

1ec5 · 2016-10-27T00:06:19Z

FYI, I'm OK with how this guide is listed at the end of the table of contents, but it might be possible to bring it to the top by specifying it in the custom table of contents in jazzy.yml.

incanus · 2016-10-27T16:00:15Z

It should be, but I was also ok with where it is now.

…docs

incanus · 2016-11-01T02:35:41Z

Pending tests, this should be all good to go again.

Also support base URL nullability in order to use default value.

incanus · 2016-11-01T17:30:08Z

Cherry-picked to 3.4.0 release branch as 8ffd1f6.

document MGLMapboxAPIBaseURL key for Info.plist; base URL nullability

d4e13d1

incanus added iOS Mapbox Maps SDK for iOS macOS Mapbox Maps SDK for macOS documentation labels Oct 26, 2016

incanus added this to the ios-v3.4.0 milestone Oct 26, 2016

incanus self-assigned this Oct 26, 2016

incanus added 2 commits October 26, 2016 10:04

line breaks

54eda25

link PR

01a67a4

[ios,macos] add Info.plist key guides

0964964

incanus changed the title ~~document custom API URL~~ document custom API URL & add Info.plist guide Oct 26, 2016

1ec5 suggested changes Oct 26, 2016

View reviewed changes

incanus added 3 commits October 26, 2016 13:54

tuneup

9100927

flesh out token docs

1650526

mention base URL default

2495cff

1ec5 suggested changes Oct 26, 2016

View reviewed changes

friedbunny approved these changes Oct 26, 2016

View reviewed changes

incanus added 5 commits October 31, 2016 19:26

Merge remote-tracking branch 'origin/master' into ios-network-config-…

ebc846c

…docs

fix formatting

7840f0f

use Markdown link syntax

1403123

move to docs

8aeac22

remove space

1c72e4a

1ec5 approved these changes Nov 1, 2016

View reviewed changes

update neglected macos changelog

86ebbb1

incanus merged commit dfd4057 into master Nov 1, 2016

incanus deleted the ios-network-config-docs branch November 1, 2016 05:34

incanus added a commit that referenced this pull request Nov 1, 2016

[ios, macos] document custom API URL & add Info.plist guide (#6833)

8ffd1f6

Also support base URL nullability in order to use default value.

1ec5 mentioned this pull request Nov 2, 2016

Update changelogs for v3.4.0-beta.2 #6875

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

document custom API URL & add Info.plist guide #6833

document custom API URL & add Info.plist guide #6833

incanus commented Oct 26, 2016

mention-bot commented Oct 26, 2016

1ec5 commented Oct 26, 2016

incanus commented Oct 26, 2016

1ec5 commented Oct 26, 2016

incanus commented Oct 26, 2016 •

edited

Loading

1ec5 left a comment

1ec5 Oct 26, 2016

incanus Oct 26, 2016

1ec5 Oct 26, 2016

incanus Oct 26, 2016

1ec5 Oct 26, 2016

incanus Oct 26, 2016

1ec5 Oct 26, 2016

incanus Nov 1, 2016

1ec5 Oct 26, 2016

incanus Nov 1, 2016

friedbunny Oct 26, 2016

incanus Nov 1, 2016

friedbunny commented Oct 26, 2016 •

edited

Loading

1ec5 commented Oct 27, 2016

incanus commented Oct 27, 2016 via email

incanus commented Nov 1, 2016

incanus commented Nov 1, 2016


		## MGLMapboxAccessToken

		Use this key to set your Mapbox API [access token](https://www.mapbox.com/help/define-access-token/). This key is required for all map use.


		## MGLMapboxAPIBaseURL

		Use this key if you need to customize the API base URL used throughout the SDK. If unset, the default Mapbox API is used.


		## MGLMapboxAccessToken

		Set the <a href="https://www.mapbox.com/help/define-access-token/">Mapbox access token</a> to be used by all instances of `MGLMapView` in the current application.

document custom API URL & add Info.plist guide #6833

document custom API URL & add Info.plist guide #6833

Conversation

incanus commented Oct 26, 2016

mention-bot commented Oct 26, 2016

1ec5 commented Oct 26, 2016

incanus commented Oct 26, 2016

1ec5 commented Oct 26, 2016

incanus commented Oct 26, 2016 • edited Loading

1ec5 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

friedbunny commented Oct 26, 2016 • edited Loading

1ec5 commented Oct 27, 2016

incanus commented Oct 27, 2016 via email

incanus commented Nov 1, 2016

incanus commented Nov 1, 2016

incanus commented Oct 26, 2016 •

edited

Loading

friedbunny commented Oct 26, 2016 •

edited

Loading