-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
22 changed files
with
472 additions
and
536 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,30 @@ | ||
# Community Modules | ||
# Introduction | ||
|
||
This repository contains a collection of community supported modules for [deck.gl](https://deck.gl). | ||
This repository contains a collection of community supported modules for [deck.gl](https://deck.gl), that are intended to complement the various modules already provided by the core deck.gl framework. While any module that is properly scoped and of sufficient value to the community could be a candidate for this repository, common modules type are: | ||
|
||
The modules in this repository are intended to be used together with deck.gl. | ||
- additional **layer packs** (beyond the various layer packs available in deck.gl) | ||
- additional **base map** integrations (beyond the integrations supported by deck.gl) | ||
- additional **react** bindings (beyond the `@deck.gl/react` module). | ||
|
||
Note that these modules are not officially supported by the deck.gl team, but have at least some part-time support from one or more community members. | ||
## Support | ||
|
||
## Incubation | ||
Community modules are not officially supported by the core deck.gl maintainers, but have at least some intermittent, part-time support from one or more community members. | ||
|
||
There is a high bar when adding new code to themain deck.gl repository. The deck.gl-community repository is sometimes used to prepare (incubate) new software components so that they are ready to be added to deck.gl. | ||
Note that the continued inclusion of each module into this repository depends to a large extent on whether there is sufficient community support for the module. Modules can be removed from this repository if the core deck.gl team feels that the community is no longer able to provide sufficient support. | ||
|
||
When proposing the addition of a new component, such as a new deck.gl layer, | ||
to the core deck.gl maintainers, it is helpful to be able to prepare the component together with tests, documentation and examples outside of the core repository but within a similar code environment. | ||
If a module was to be removed, applications can of course copy the module's source code, but will need to maintain the code on their own. | ||
|
||
To be clear, many components in this repository are not intended to be added to the main deck.gl repository. | ||
## Contributing | ||
|
||
## Longevity | ||
If you have a module that you think could fit into this repository, please start by opening a GitHub issue to start a discussion, or reach out in the OpenJS slack. | ||
|
||
The continued inclusion of each module into this repository depends to a large extent on whether there is sufficient community interest in supporting the module. Modules can be removed if the core deck.gl team feels that there is no longer sufficient support. | ||
## Upstreaming | ||
|
||
## Contributing a module | ||
On rare occasions, a new component or module may be "upstreamed" into the core deck.gl repository. | ||
|
||
If you have a module that you think could fit into this repository, open an issue or PR and start a discussion, or reach out in the OpenJS slack. | ||
There is a high bar when adding new code to the main deck.gl repository. The deck.gl-community repository is sometimes used to prepare (incubate) new software components so that they are ready to be added to deck.gl. | ||
|
||
Therefore when proposing the addition of a new component (such as a new deck.gl layer), | ||
to the core deck.gl maintainers, it is helpful to be able to prepare the component in a monorepo environment that is similar to the deck.gl repo, complete with tests, documentation and examples. This can avoid a length and frustrating review process in the deck.gl repo. | ||
|
||
To set expectations, most components in this repository will never be added to the main deck.gl repository. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
## API Reference | ||
# DeckOverlay | ||
|
||
### loadModules | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.