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

Clarity around plugins contribution model #4260

Closed
stevage opened this issue Feb 13, 2017 · 3 comments
Closed

Clarity around plugins contribution model #4260

stevage opened this issue Feb 13, 2017 · 3 comments

Comments

@stevage
Copy link
Contributor

stevage commented Feb 13, 2017

I'd be interested in contributing a couple of Mapbox-GL-JS plugins, if Mapbox is accepting third-party plugins. But I can't see anything about what the contribution model is - what standard, if any, is required. The only blog post I see refers only to Control plugins.

A couple I had in mind (the basic work is already done):

@lucaswoj
Copy link
Contributor

There is no single type of plugin for GL JS. For example, there are plugins that add new UI elements, plugins that draw to canvas layers, and plugins that do data preprocessing. Therefore there is no single standard for plugins.

The plugin contribution model is

  • you create a plugin that uses the public GL JS APIs to do something useful
  • you publish the plugin on a CDN (https://unpkg.com is easy)
  • you submit a PR to add that plugin to our documentation (we're working on revamping this architecture right now, it's a little confusing at the moment)
  • we accept the PR so long as the plugin is well-designed and well-maintained

supporting SimpleStyle for GeoJSON objects

I'd recommend the plugin exist as a function that turns a GeoJSON into a Mapbox Style

animated flyTo loops (a sort of workaround for #981)

I'd recommend the plugin exist external to GL JS and call its methods.

3D extruded-fill visualisations of datasets (see https://city-of-melbourne.github.io/Data3D/ )

I'd recommend the plugin exist as a function that turns a GeoJSON and some options into a Mapbox Style

@jfirebaugh
Copy link
Contributor

supporting SimpleStyle for GeoJSON objects

Have you seen https://github.com/mapbox/simplespec-to-gl-style?

@stevage
Copy link
Contributor Author

stevage commented Feb 14, 2017

Thanks!

Have you seen https://github.com/mapbox/simplespec-to-gl-style?

No I hadn't, thanks :)

animated flyTo loops (a sort of workaround for #981)

I'd recommend the plugin exist external to GL JS and call its methods.

Yeah, something like this:

flyPath(map, route)

where route is a GeoJSON object set of points with AnimationOptions as metadata.

3D extruded-fill visualisations of datasets (see https://city-of-melbourne.github.io/Data3D/ )

I'd recommend the plugin exist as a function that turns a GeoJSON and some options into a Mapbox Style

Well, it needs to add a source to the map as well, so probably needs to be passed the map object, but yeah.

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

No branches or pull requests

3 participants