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

Document plugins #13

Closed
4 tasks
zugaldia opened this issue Apr 11, 2017 · 7 comments
Closed
4 tasks

Document plugins #13

zugaldia opened this issue Apr 11, 2017 · 7 comments
Assignees
Milestone

Comments

@zugaldia
Copy link
Member

Once we're able to publish the plugins to Maven #3 and once we have the first plugin ready #4 (both are happening shortly) we'll want to make this repository available for anyone to use. For this to happen we have to document:

  • the list of available plugins with descriptions
  • information on how to install them via Maven/Gradle
  • examples on how to use them (reference implementation is in the test app)
  • information on how to contribute a plugin

Initially, we can use the README file in this repo but, ideally, we'll integrate this documentation with the rest of the Android docs (new Plugins tab in https://www.mapbox.com/android-docs?).

@langsmith Could you add to OP anything I might have missed and run point on this?

@ericrwolfe Do we have a similar ticket for iOS? Do we have any comms plans in the pipeline?

cc: @cammace @tobrun

@langsmith langsmith self-assigned this Apr 11, 2017
@langsmith
Copy link
Contributor

Will do @zugaldia

@langsmith
Copy link
Contributor

cc @danswick

@langsmith
Copy link
Contributor

Initial draft of Plugin docs layout. Lots more to come...

giphy

@zugaldia zugaldia modified the milestone: v0.1 Apr 24, 2017
@zugaldia zugaldia mentioned this issue Apr 24, 2017
5 tasks
@zugaldia
Copy link
Member Author

@langsmith Anything that we should bring to this repo's README. I think having this file in good shape is the absolute minimum we should have ready before the release.

@langsmith
Copy link
Contributor

@zugaldia , I've cleaned up and re-ordered the readme so that the repo's at least fit for a release. Here's the PR for the readme update

@zugaldia
Copy link
Member Author

@langsmith thank you! I'll give it a pass and merge it.

@tobrun
Copy link
Member

tobrun commented May 3, 2017

this has been merged 🎉, closing

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants