mapbox / mapbox/mapbox-navigation-android-examples
Migrate examples from `MapboxNavigationProvider` to `MapboxNavigationApp`
Nobody has claimed this yet.
- Dominant language
- Kotlin
- Stars
- 65
- Forks
- 56
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 2
Description
It will be some time before we upgrade the examples repository to com.mapbox.navigation:android:2.8.0-alpha.2.
Opening so we can start considering the migration, but we're still building tools that make migration easier
For example the extensions are still experimental.
- ShowAlternativeRoutesActivity
- ShowManeuversActivity
- MultipleWayPointsActivity
- ShowTripProgressActivity
- ShowCameraTransitionsActivity
- ShowCurrentLocationActivity
- ShowJunctionsActivity
- FetchARouteActivity
- RenderRouteLineActivity
- TurnByTurnExperienceActivity
- MapboxSignboardActivity
- PlayVoiceInstructionsActivity
- ShowSpeedLimitActivity
- ReplayHistoryActivity
- CustomArrivalActivity
- ShowBuildingExtrusionsActivity
Migration plan
We want to commit to a migration plan for the examples repository by September 5th because that is the week the 2.8.0 release becomes a release candidate and we will be committed to apis for a stable release.
Note that, not-migrating and using MapboxNavigation directly is also an option. MapboxNavigationApp is built for large apps.
Resources
The architecture is designed for you to build de-coupled classes like the LocationComponent, or a more complicated example is the CameraComponent. There are other approaches that are worth considering.
Some public documentation on the MapboxNavigationApp can be found here https://docs.mapbox.com/android/navigation/guides/androidauto/car-app-lifecycle/
We will also explore migration ideas in the qa-test-app
Ideas are welcome
I'm obviously not the only one using this new library, so feel free to bring in some opinions and ideas. Feel free to open a pull request against this migrate-MapboxNavigationApp branch. Or create new pull requests.
cc: @mapbox/navigation-android
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the migration plan and the listed example activities, then review the MapboxNavigationApp documentation and the qa-test-app for migration patterns. The migrate-MapboxNavigationApp branch and the linked architecture resources provide additional context. Done means either migrating the listed examples consistently or documenting a decision to continue using MapboxNavigation directly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- mobile
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100