Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve installation docs #2541

Merged
merged 2 commits into from
Oct 11, 2018
Merged

Improve installation docs #2541

merged 2 commits into from
Oct 11, 2018

Conversation

keksipurkki
Copy link
Contributor

Does any other open PR do the same thing?

Checked open PRs for keywords 'docs' and 'documentationä. None found.

Not relevant.

What issue is this PR fixing?

None. This is a general improvement to the documentation.

How did you test this PR?

The PR does not contain executable code.

No executable code. However, I spent the entire day debugging the maps build for iOS and decided to share the lessons learned.

This PR contains updates for the installation guide:

  • Gave the installation documentation a good formatting scrub.
  • Revised the troubleshooting section
  • Documented clearly that the library ships with two map backends for iOS (was not clear to me).

View the proposed version at:
https://github.com/keksipurkki/react-native-maps/blob/feat/update-docs/docs/installation.md

Thanks for your good work!

@todorone
Copy link
Contributor

Amazing job @keksipurkki, installation instructions are not very user-friendly now, especially for those, who are not very familiar with native mobile builds flow...

console.log(region);

return (
<View style ={styles.container}>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redundant space after style

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

@rborn
Copy link
Collaborator

rborn commented Oct 11, 2018

@keksipurkki amazing work, merging ❤️🎉

@rborn rborn merged commit a45f7a7 into react-native-maps:master Oct 11, 2018
ryanbourneuk pushed a commit to 3sidedcube/react-native-maps that referenced this pull request Dec 10, 2018
* upstream/master: (28 commits)
  Calculate bounding box from region (react-native-maps#2615)
  [iOS GoogleMap] Fix animateCamera (react-native-maps#2608)
  Fix type definition error (react-native-maps#2607)
  [Android] Fix app crash in Android if building found but cannot getActiveLevelIndex (react-native-maps#2598)
  Provide a camera system (react-native-maps#2563)
  Get visible map bounding box (react-native-maps#2571)
  [0.22.1] Release (react-native-maps#2574)
  Move dev only deps to devDependencies. (react-native-maps#2548)
  Specify how to use Google Maps (react-native-maps#2550)
  r2507: remove marker: Attempt to invoke virtual method 'void com.google.android.gms.maps.model.setIcon(com.google.android.gms.maps.model.BitmapDescription)' on a null object reference #: remove marker: Attempt to invoke virtual method 'void com.google.android.gms.maps.model.setIcon(com.google.android.gms.maps.model.BitmapDescription)' on a null object reference (react-native-maps#2555)
  update to clarify cacheEnabled is apple maps only
  [0.22.0] Release (react-native-maps#2535)
  Fix for “The specified child already has a parent”
  Improve installation docs (react-native-maps#2541)
  fix fitToSuppliedMarkers function (react-native-maps#2524)
  Performance improvements for tracksViewChanges (react-native-maps#2487)
  fix spelling mistakes
  Added flag to make sure that there has an Observer of view.
  hotfix PR react-native-maps#2478
  Fix a peer dependencies warning
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants