[ios, macos] Remove duplicated guides, rename to appendices by captainbarbosa · Pull Request #12540 · mapbox/mapbox-gl-native

captainbarbosa · 2018-08-02T20:51:39Z

Removes a handful of guides and associated assets that have been ported over to the new Mapbox Maps SDK for iOS page.

Partially addresses #11043.

1ec5 · 2018-08-14T18:48:19Z

 Dynamic Type and Accessibility Text features to increase the size of all text on
 the device. You can use the
-[runtime styling API](#manipulating-the-style-at-runtime) to adjust your style’s
+[runtime styling API](https://www.mapbox.com/ios-sdk/maps/overview/runtime-styling/) to adjust your style’s


This change is unnecessary; there’s still a “Manipulating the style at runtime” section. That’s important because it’s the only documentation we have between /ios-sdk and the jazzy docset that names the specific classes that form the runtime styling API.

friedbunny · 2018-08-14T19:56:08Z

If we can, let’s get this into ios-v4.3.0.

julianrex · 2018-08-14T20:22:07Z

 Dynamic Type and Accessibility Text features to increase the size of all text on
 the device. You can use the
-[runtime styling API](#manipulating-the-style-at-runtime) to adjust your style’s
+[runtime styling API](#manipulating-the-style-at-runtime) to adjust your style’s to adjust your style’s


friedbunny

One nit, but otherwise looks good. Perhaps it’d also be useful if you could post the update process you went through as a comment here, for posterity.

friedbunny · 2018-08-14T21:39:53Z

 the device. You can use the
-[runtime styling API](#manipulating-the-style-at-runtime) to adjust your style’s
-font and icon sizes accordingly.
+[runtime styling API](#manipulating-the-style-at-runtime) to adjust your style’s font and icon sizes accordingly.


For consistency, let’s keep wrapping lines in this doc at 80 characters.

1ec5 · 2018-08-14T21:47:50Z

 If you previously used an interpolation base greater than `0` (other than `1`), you can use `MGLExpressionInterpolationMode.exponential` as the curve type for `+[NSExpression(MGLAdditions) mgl_expressionForInterpolatingExpression:withCurveType:parameters:stops:]` or `'exponential'` as the curve type for [`mgl_interpolate:withCurveType:parameters:stops:`](predicates-and-expressions.html#code-mgl_interpolate-withcurvetype-parameters-stops-code). The `parameters` argument takes that interpolation base. This interpolates between values exponentially, creating an accelerated ramp effect.

-Here’s a visualization from Mapbox Studio (see [Working with Mapbox Studio](working-with-mapbox-studio.html)) comparing interpolation base values of `1.5` and `0.5` based on zoom. In order to convert camera style functions, use `$zoomLevel` or `MGL_FUNCTION('zoomLevel')` as the attribute key.
+Here’s a visualization from Mapbox Studio (see [Working with Mapbox Studio](https://www.mapbox.com/ios-sdk/maps/overview/mapbox-studio/)) comparing interpolation base values of `1.5` and `0.5` based on zoom. In order to convert camera style functions, use `$zoomLevel` or `MGL_FUNCTION('zoomLevel')` as the attribute key.


The new guide is called “Mapbox Studio and iOS”, not “Working with Mapbox Studio”.

1ec5 · 2018-08-14T21:49:11Z

@@ -17,9 +17,6 @@ framework_root: ../darwin/src
 custom_categories:
  - name: Guides


Should we keep calling this section “Guides” or refashion it as “Appendices” to clarify their scope?

1ec5 · 2018-08-14T21:50:08Z

 # Migrating from Style Functions to Expressions

-[Runtime Styling](runtime-styling.html) enables you to modify every aspect of the map’s appearance dynamically as a user interacts with your application. Developers can specify in advance how a layout or paint attribute will vary as the zoom level changes or how the appearance of individual features vary based on metadata provided by a content source.
+[Runtime Styling](https://www.mapbox.com/ios-sdk/maps/overview/runtime-styling/) enables you to modify every aspect of the map’s appearance dynamically as a user interacts with your application. Developers can specify in advance how a layout or paint attribute will vary as the zoom level changes or how the appearance of individual features vary based on metadata provided by a content source.


Kinda awkward that this macOS appendix is linking to an explicitly iOS-specific guide, but it’s better than nothing I guess.

captainbarbosa · 2018-08-14T22:12:03Z

Accidentally edited the platform/ios/docs/guides docs instead of platform/darwin/docs/guides 🙈

captainbarbosa · 2018-08-14T23:42:57Z

I forgot to squash these commits 🙈 I'll remember to rebase + squash + merge next time.

1ec5 · 2018-08-15T00:02:09Z


 custom_categories:
-  - name: Guides
+  - name: Appendices


The macOS table of contents can also call them appendices. I can take care of that at release time if you don’t get to it first.

I opened a new PR: #12634

Fix pod name within docs #12645 Add info on using a keypath containing a dot to Predicates & Expressions guide #12599 Remove duplicated guides, rename to appendices #12540 Copyedit iOS, macOS changelogs #12641, #12650

[ios] Remove duplicated guides

13f1782

captainbarbosa added iOS Mapbox Maps SDK for iOS documentation labels Aug 2, 2018

captainbarbosa self-assigned this Aug 2, 2018

captainbarbosa requested a review from 1ec5 August 2, 2018 20:51

1ec5 reviewed Aug 14, 2018

View reviewed changes

friedbunny added this to the ios-v4.3.0 milestone Aug 14, 2018

Edit link

0c1f288

captainbarbosa requested a review from friedbunny August 14, 2018 20:13

julianrex reviewed Aug 14, 2018

View reviewed changes

captainbarbosa added 3 commits August 14, 2018 13:23

Fix typo

df33a51

Update darwin docs

0939d2b

Addiional darwin fixes and Jazzy template updates

0d8b4d0

friedbunny approved these changes Aug 14, 2018

View reviewed changes

1ec5 reviewed Aug 14, 2018

View reviewed changes

captainbarbosa added 2 commits August 14, 2018 14:52

Fix line break

23d0e33

Rename link title

a4b7544

Guides -> Appendices

5b8da37

captainbarbosa changed the title ~~[ios] Remove duplicated guides~~ [ios] Remove duplicated guides, rename to appendices Aug 14, 2018

captainbarbosa changed the title ~~[ios] Remove duplicated guides, rename to appendices~~ [ios, macos] Remove duplicated guides, rename to appendices Aug 14, 2018

captainbarbosa merged commit c96d9df into master Aug 14, 2018

captainbarbosa deleted the cleanup-ios-guides-nb branch August 14, 2018 23:38

captainbarbosa restored the cleanup-ios-guides-nb branch August 14, 2018 23:41

captainbarbosa deleted the cleanup-ios-guides-nb branch August 14, 2018 23:41

1ec5 reviewed Aug 15, 2018

View reviewed changes

captainbarbosa mentioned this pull request Aug 15, 2018

[macos] Rename Guides to Appendices #12634

Merged

julianrex pushed a commit that referenced this pull request Aug 15, 2018

[ios] Remove duplicated guides (CP #12540)

ff62d02

julianrex mentioned this pull request Aug 15, 2018

v4.3.0 consolidated cherry-picks (into release-espresso) #12648

Merged

		@@ -17,9 +17,6 @@ framework_root: ../darwin/src
		custom_categories:
		- name: Guides

Conversation

captainbarbosa commented Aug 2, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

friedbunny commented Aug 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

friedbunny left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

captainbarbosa commented Aug 14, 2018

Uh oh!

captainbarbosa commented Aug 14, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants