Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Update project documentation #8390

Closed
13 tasks done
tobrun opened this issue Mar 14, 2017 · 9 comments · Fixed by #9788
Closed
13 tasks done

Update project documentation #8390

tobrun opened this issue Mar 14, 2017 · 9 comments · Fixed by #9788
Labels
Android Mapbox Maps SDK for Android documentation

Comments

@tobrun
Copy link
Member

tobrun commented Mar 14, 2017

Ticket tracking project documentation changes for /platform/android
The current .MD files in our repository for Android our outdated and we need to addmore usefull information for debugging, building and distributing .so and .aar files:

  • Update documentation with Android IDE integration from Integrate CMake build into Gradle + Android Studio #8363
  • Cleanup old wiki pages
  • Review build requirements
  • Cleanup CONTRIBUTING.MD
  • Update test/run documentation in MapboxGLAndroidSDKTestApp
  • update make android-help - command with other targets
  • add make android-help to documentation
  • update ndk-stack documentation
  • Update distributing with .aar section, apk split and abi filter configuration
  • Add information about style spec changes and code generation
  • Update release documentation with Circle CI information
  • Make checkstyle setup discoverable / part of getting started
@tobrun
Copy link
Member Author

tobrun commented May 15, 2017

Added a section in OP, to update release documentation related to CircleCI migration (more specifcally about changing CircleCI config to build a release + changing the config to original state afterwards).

@zugaldia
Copy link
Member

cc: @langsmith @cammace to help support the effort.

@cammace
Copy link
Contributor

cammace commented May 15, 2017

Also noting here (not sure if ticketed) that all public methods need to have the corresponding javadoc.

@tobrun
Copy link
Member Author

tobrun commented Jun 13, 2017

Parts of this issue should still be picked up before a final 5.1.0 release (for this reason, keeping it to this milestone). After fixes have landed we can move this to a 5.2.0 milestone (though it would be great to resolve all the todo's).

@zugaldia
Copy link
Member

Parts of this issue should still be picked up before a final 5.1.0 release (for this reason, keeping it to this milestone).

What work is left (if any) for the current 5.1?

@tobrun
Copy link
Member Author

tobrun commented Jun 20, 2017

the javadoc was the missing part, that is fixed with #9266, moving to next milestone for now.

@tobrun tobrun modified the milestones: android-future, android-v5.1.0 Jun 20, 2017
@tobrun
Copy link
Member Author

tobrun commented Aug 17, 2017

NDK stack documentation has been updated here to reflect changes in our build system (the .so files are found in a different place).

@tobrun tobrun modified the milestones: android-v5.2.0, android-future Aug 17, 2017
@zugaldia
Copy link
Member

@tobrun Looks like all items in OP are now checked, are we good to close?

@tobrun
Copy link
Member Author

tobrun commented Aug 17, 2017

#9788 is targeting to close this, so once CI approves and PR is merged, this will be closed ;)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Android Mapbox Maps SDK for Android documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants