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

Example: using LocationComponent to show the user's current location #812

Closed
louwers opened this issue Feb 15, 2023 · 12 comments · Fixed by #1169
Closed

Example: using LocationComponent to show the user's current location #812

louwers opened this issue Feb 15, 2023 · 12 comments · Fixed by #1169
Assignees
Labels
android 💰 bounty S Small Bounty, USD 100 documentation Improvements or additions to documentation

Comments

@louwers
Copy link
Collaborator

louwers commented Feb 15, 2023

Create a pull requests that includes a tutorial of how to show the user's current location. This issue has an associated bounty for the documentation bounty direction.

Deliverables

  • The example should cover showing the user's current location with the LocationComponent.
  • It should be added as an activity to MapboxGLAndroidSDKTestApp (you can use an existing one if it makes sense).
  • Docs should be added to MdBook in docs/mdbook. Use an 'anchor comment' and regular expressions to include the Kotlin source code in the docs. Explained here: https://rust-lang.github.io/mdBook/format/mdbook.html#including-portions-of-a-file
  • Explain that you can configure the LocationComponent with LocationComponentActivationOptions.Builder.
  • The example should cover how to change the color of the puck.
  • Code samples should use Kotlin
  • Include at least two screenshots in your tutorial (you may want to provide a fake location to not expose your location). Drag and drop them to GitHub so we don't need to store them in the git tree.
  • Please don't re-use any guides or tutorials that do not have a permissive license. This might be helpful, which does have a permissive license (so can be used).
@louwers louwers added documentation Improvements or additions to documentation android 💰 bounty S Small Bounty, USD 100 labels Feb 15, 2023
@typebrook
Copy link
Collaborator

Hi @louwers
May I also work on this?

@louwers
Copy link
Collaborator Author

louwers commented May 17, 2023

You may, but I want to set up a separate repository for the Android examples first. And let's get the other issue merged & finished first.

https://github.com/maplibre/maplibre-native-android-examples

I also want to set up CI to ensure all the examples continue to compile. Source code in Markdown files is too brittle.

If this is something you are comfortable setting up, maybe we can have a chat about it first so we can define the scope and how much work you think it would be. I also asked @fynngodau

@typebrook
Copy link
Collaborator

https://github.com/maplibre/maplibre-native-android-examples

That would be great! Just curious, is this repo only used for build test, or it will become a demo app for many showcases (maybe publish on Google Play Store)? Like https://github.com/mapbox/mapbox-android-demo

@louwers
Copy link
Collaborator Author

louwers commented May 17, 2023

We are probably going to use https://github.com/maplibre/maplibre-native/tree/main/platform/android/MapboxGLAndroidSDKTestApp because all the infrastructure to build and test it is already in place.

@typebrook
Copy link
Collaborator

typebrook commented May 17, 2023

Does that means #1135 should continue #741, update all Activities in com/mapbox/mapboxsdk/testapp/activity/annotation/ ? (Also, add JsonApiActivity.kt for demo in docs)

@louwers
Copy link
Collaborator Author

louwers commented May 19, 2023

@typebrook I modified the acceptance criteria for this bounty.

If you still would like to work on this, let me know and I can assign you!

@typebrook
Copy link
Collaborator

Yes, I'll take this.

@typebrook
Copy link
Collaborator

@louwers #1169 is made. Let's have further discussion there

@louwers
Copy link
Collaborator Author

louwers commented Jun 12, 2023

This bounty can be paid out.

@typebrook
Copy link
Collaborator

typebrook commented Jun 12, 2023

@fynngodau
Copy link
Collaborator

@typebrook Probably you have linked the wrong invoice, the correct one appears to be: https://opencollective.com/maplibre/expenses/143821

@typebrook
Copy link
Collaborator

@fynngodau Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
android 💰 bounty S Small Bounty, USD 100 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants