Skip to content

Commit

Permalink
Update more links (#4514)
Browse files Browse the repository at this point in the history
* Update more doc links
  • Loading branch information
1chandu authored and Pessimistress committed Apr 26, 2020
1 parent d907af4 commit c12fe94
Show file tree
Hide file tree
Showing 21 changed files with 43 additions and 45 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</a>
</p>

<h1 align="center">deck.gl | <a href="https://visgl.github.io/deck.gl">Website</a></h1>
<h1 align="center">deck.gl | <a href="https://deck.gl">Website</a></h1>

<h5 align="center"> WebGL2-powered, highly performant large-scale data visualization</h5>

Expand Down Expand Up @@ -82,7 +82,7 @@ pip install pydeck
* [Interactive playground](https://deck.gl/playground)
* [deck.gl Codepen demos](https://codepen.io/vis-gl/)
* [deck.gl Observable demos](https://beta.observablehq.com/@pessimistress)
* [vis.gl Medium blog](https://medium.com/vis-gl)
* [vis.gl Medium blog](https://medium.com/vis-gl)
* [deck.gl Slack workspace](https://join.slack.com/t/deckgl/shared_invite/zt-7oeoqie8-NQqzSp5SLTFMDeNSPxi7eg)

## Contributing
Expand All @@ -103,4 +103,3 @@ Data sources are listed in each example.
<a href="https://www.browserstack.com/">
<img src="https://d98b8t1nnulk5.cloudfront.net/production/images/static/logo.svg" alt="BrowserStack" width="200" />
</a>

2 changes: 1 addition & 1 deletion bindings/pydeck/pydeck/io/static/index.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev-docs/RFCs/v7.2/layer-extension-rfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ As the deck.gl layers ecosystem grows, we see many feature requests as variation

To begin with, adding a feature to an existing core layer is no easy task. It usually involves modification to multiple steps in the layer lifecycle, e.g. adding new props, uniforms, declaring and generating new attributes, and injecting code into the shaders. It requires the author to understand the general WebGL render pipeline and GLSL, deck.gl's layer lifecycle and attribute management system, and sometimes luma.gl. This is outlined in our tutorial for [subclassed layers](/docs/developer-guide/subclassed-layers.md).

Secondly, because of the ad-hoc nature of layer customization, it is difficult to package and reuse an "extension" for other layers. This is apprent in the [kepler.gl repo](https://github.com/uber/kepler.gl/tree/master/src/deckgl-layers) where a custom version of every core layer must be created in order to override a simple default bahavior.
Secondly, because of the ad-hoc nature of layer customization, it is difficult to package and reuse an "extension" for other layers. This is apprent in the [kepler.gl repo](https://github.com/keplergl/kepler.gl/tree/master/src/deckgl-layers) where a custom version of every core layer must be created in order to override a simple default bahavior.

To mitigate this, we can of course add as many customizable functionalities to the base layer as possible. However, it is a major concern that inflating the base layer will sacrefice performance in return. Additional attributes takes CPU cycles to generate and memory to store. Larger shaders take longer to compile. WebGL1 has a restricting limit of 16 attributes per vertex shader, so adding attributes without the user asking for it will make the layer less extensible instead.

Expand Down
2 changes: 1 addition & 1 deletion dev-docs/RFCs/v7.2/property-animation-rfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Animation can benefit from the prop type system. The following Property Types su

To make time-based animation work, the idea is that individual props could be set to "updater functions" in addition to constant values. The functions would be called every time the layer is updated (whether through a render or a time-based update).

The updated functions would take a context parameter (see the luma.gl [AnimationLoop](https://uber.github.io/luma.gl/#/documentation/api-reference/animation-loop) for a good reference on how this would work).
The updated functions would take a context parameter (see the luma.gl [AnimationLoop](https://visgl.github.io/luma.gl/docs/api-reference/animation-loop) for a good reference on how this would work).

```js
const layer = new Layer {
Expand Down
2 changes: 1 addition & 1 deletion dev-docs/RFCs/v7.2/property-transition-rfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ In deck.gl v7.2:

The idea here is that setting a new value on an "interpolatable" props would not immediately make the layer take the new value, but would instead slowly animate the value from it's current state to its new.

This way this would work is similar to how the current deck.gl [HexagonLayer demo](https://uber.github.io/deck.gl/#/examples/core-layers/hexagon-layer) on startup slowly increases elevation of the hexagon from zero. Except there would be no application code necessary to achieve this. The layer would be set in interpolation mode, and would start rendering
This way this would work is similar to how the current deck.gl [HexagonLayer demo](https://visgl.github.io/deck.gl/#/examples/core-layers/hexagon-layer) on startup slowly increases elevation of the hexagon from zero. Except there would be no application code necessary to achieve this. The layer would be set in interpolation mode, and would start rendering

### Issue: Speed of Interpolation

Expand Down
3 changes: 1 addition & 2 deletions dev-docs/RFCs/v7.2/python-integration-rfc.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ x* We do not currently publish the JSON module as part of the standalone bundle

### kepler.gl Jupyter Integration

* [RFC](https://github.com/uber/kepler.gl/issues/331)
* [RFC](https://github.com/keplergl/kepler.gl/issues/331)


### Mapbox Jupyter Integration
Expand All @@ -167,4 +167,3 @@ Minimal integrations for other languages? Especially languages that run in Noteb
### R

See the [mapdeck](https://symbolixau.github.io/mapdeck/articles/mapdeck.html) integration for R.

2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ deck.gl is developed in parallel with a number of companion modules, including:

* [luma.gl](https://luma.gl/) - A general purpose WebGL library designed to be interoperable both with the raw WebGL API and (as far as possible) with other WebGL libraries. In particular, luma.gl does not claim ownership of the WebGL context, and can work with any supplied context, including contexts created by the application or other WebGL libraries.
* [loaders.gl](https://loaders.gl) - a suite of framework-independent loaders for file formats focused on visualization of big data, including point clouds, 3D geometries, images, geospatial formats as well as tabular data.
* [react-map-gl](https://uber.github.io/react-map-gl/) - A React wrapper around Mapbox GL which works seamlessly with deck.gl.
* [react-map-gl](https://visgl.github.io/react-map-gl/) - A React wrapper around Mapbox GL which works seamlessly with deck.gl.
* [nebula.gl](https://nebula.gl/) - A high-performance feature editing framework for deck.gl.


Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/using-with-map.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ When using deck.gl and Mapbox, there are two options you can choose from:

[react-map-gl](https://github.com/visgl/react-map-gl) is a React wrapper around mapbox-gl. If you'd like to use deck.gl with React, this component is the recommended companion.

All the [examples on this website](https://github.com/visgl/deck.gl/tree/8.1-release/examples/website) are implemented using the React integration. The `DeckGL` React component works especially well as the parent of a react-map-gl [StaticMap](https://uber.github.io/react-map-gl/#/Documentation/api-reference/static-map), which automatically interprets the deck.gl view state (i.e. latitude, longitude, zoom etc). In this configuration your deck.gl layers will render as a perfectly synchronized geospatial overlay over the underlying map.
All the [examples on this website](https://github.com/visgl/deck.gl/tree/8.1-release/examples/website) are implemented using the React integration. The `DeckGL` React component works especially well as the parent of a react-map-gl [StaticMap](https://visgl.github.io/react-map-gl/#/Documentation/api-reference/static-map), which automatically interprets the deck.gl view state (i.e. latitude, longitude, zoom etc). In this configuration your deck.gl layers will render as a perfectly synchronized geospatial overlay over the underlying map.

### About Mapbox Tokens

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/using-with-react.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ For more information on this syntax, see [DeckGL API](/docs/api-reference/react/
## Remarks

* The `DeckGL` component is typically rendered as a child of a
map component like [react-map-gl](https://uber.github.io/react-map-gl/#/),
map component like [react-map-gl](https://visgl.github.io/react-map-gl/#/),
but could be rendered as a child of any React component that you want to
overlay your layers on top of.

Expand Down
4 changes: 2 additions & 2 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ See [View class](/docs/api-reference/view.md) documentation for details.
#### Core

- `layer.setLayerNeedsUpdate` is renamed to `layer.setNeedsUpdate()` and the old name will be removed in the next major release.
- Previously deprecated `Layer` class method, `screenToDevicePixels`, is removed. Use luma.gl [utility methods](https://luma.gl/#/documentation/api-reference/webgl-2-classes/device-pixels) instead.
- Previously deprecated `Layer` class method, `screenToDevicePixels`, is removed. Use luma.gl [utility methods](https://luma.gl/docs/api-reference/webgl-2-classes/device-pixels) instead.

#### Layers

Expand Down Expand Up @@ -450,7 +450,7 @@ The default coordinate system `COORDINATE_SYSTEM.LNGLAT` is upgraded to offer hi

#### luma.gl v6.0

deck.gl v6.0 brings in luma.gl v6.0 which is a major release with a few breaking changes. The change that is most likely to affect deck.gl applications is probably that the way the `GL` constant is imported has changed. For details, see to the luma.gl [Upgrade Guide](https://luma.gl/#/documentation/overview/upgrade-guide).
deck.gl v6.0 brings in luma.gl v6.0 which is a major release with a few breaking changes. The change that is most likely to affect deck.gl applications is probably that the way the `GL` constant is imported has changed. For details, see to the luma.gl [Upgrade Guide](https://luma.gl/docs/overview/upgrade-guide).


#### Pixel sizes
Expand Down
6 changes: 3 additions & 3 deletions docs/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ The following table compares the performance between CPU and GPU aggregations us

### Use react-map-gl Components with DeckGL

For React users, it is now easy to use [react-map-gl](http://uber.github.io/react-map-gl/#/Examples/markers-popups) components with DeckGL, including DOM-based [marker](https://uber.github.io/react-map-gl/#/Documentation/api-reference/marker), [popup](https://uber.github.io/react-map-gl/#/Documentation/api-reference/popup), [navigation control](https://uber.github.io/react-map-gl/#/Documentation/api-reference/navigation-control), [fullscreen control](https://uber.github.io/react-map-gl/#/Documentation/api-reference/fullscreen-control) and [geolocate control](https://uber.github.io/react-map-gl/#/Documentation/api-reference/geolocate-control). This can be done by supplying the `ContextProvider` prop on `DeckGL`:
For React users, it is now easy to use [react-map-gl](https://visgl.github.io/react-map-gl/examples/controls) components with DeckGL, including DOM-based [marker](https://visgl.github.io/react-map-gl/docs/api-reference/marker), [popup](https://visgl.github.io/react-map-gl/docs/api-reference/popup), [navigation control](https://visgl.github.io/react-map-gl/docs/api-reference/navigation-control) and [fullscreen control](https://visgl.github.io/react-map-gl/docs/api-reference/fullscreen-control). This can be done by supplying the `ContextProvider` prop on `DeckGL`:

```jsx
/// Example using react-map-gl controls with deck.gl
Expand Down Expand Up @@ -1109,11 +1109,11 @@ In addition, the `queryObject` offers a much requested `radius` parameter, allow

### Shader Assembly

For developers that write their own custom layers, the `shadertools` shader assembly system is now in place to replace the existing `assembleShaders` function in deck.gl. The new shader assembler system supports organizing shader code into modules and is integrated with luma.gl's [`Model`](http://uber.github.io/luma.gl/#/documentation/api-reference/model) so users no longer need to call `assembleShaders` before creating the `Model` for the layer.
For developers that write their own custom layers, the `shadertools` shader assembly system is now in place to replace the existing `assembleShaders` function in deck.gl. The new shader assembler system supports organizing shader code into modules and is integrated with luma.gl's [`Model`](https://luma.gl/docs/api-reference/engine/model) so users no longer need to call `assembleShaders` before creating the `Model` for the layer.

### Per-Layer Control of WebGL Parameters

The base `Layer` class (which is inherited by all layers) supports a new property `parameters` that allows applications to specify the state of WebGL parameters such as blending mode, depth testing etc. This provides applications with significant control over the detailed rendering of layers. Note that the new `parameters` prop directly leverages the luma.gl v4 [setParameters](http://uber.github.io/luma.gl/#/documentation/api-reference/get-parameter) API, which allows all WebGL parameters to be specified as keys in a single parameter object.
The base `Layer` class (which is inherited by all layers) supports a new property `parameters` that allows applications to specify the state of WebGL parameters such as blending mode, depth testing etc. This provides applications with significant control over the detailed rendering of layers. Note that the new `parameters` prop directly leverages the luma.gl v4 [setParameters](https://luma.gl/docs/api-reference/gltools/parameter-setting#setparameters) API, which allows all WebGL parameters to be specified as keys in a single parameter object.


### Layer Attribute Control
Expand Down
8 changes: 4 additions & 4 deletions examples/gallery/build-tools/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@

<meta name="description" content="WebGL-based visualization examples using deck.gl">

<link rel="icon" type="img/ico" href="https://uber.github.io/deck.gl/favicon.ico">
<link rel="icon" type="img/ico" href="https://visgl.github.io/deck.gl/favicon.ico">

<!-— facebook open graph tags -->
<meta property="og:url" content="https://uber.github.io/deck.gl/showcases/gallery" />
<meta property="og:url" content="https://visgl.github.io/deck.gl/showcases/gallery" />
<meta property="og:title" content="deck.gl Script Gallery | WebGL visualization" />
<meta property="og:description" content="WebGL-based visualization examples using deck.gl" />
<meta property="og:site_name" content="deck.gl" />
<meta property="og:image" content="https://uber.github.io/deck.gl/images/trips-layer-unfurl-4.0.jpg" />
<meta property="og:image" content="https://visgl.github.io/deck.gl/images/trips-layer-unfurl-4.0.jpg" />
<meta property="og:image:type" content="image/jpeg" />
<meta property="og:image:width" content="800" />
<meta property="og:image:height" content="800" />
Expand All @@ -24,7 +24,7 @@
<meta name="twitter:creator" content="@uber">
<meta name="twitter:title" content="deck.gl Script Gallery | WebGL visualization">
<meta name="twitter:description" content="WebGL-based visualization examples using deck.gl">
<meta name="twitter:image" content="https://uber.github.io/deck.gl/images/trips-layer-unfurl-4.0.jpg" />
<meta name="twitter:image" content="https://visgl.github.io/deck.gl/images/trips-layer-unfurl-4.0.jpg" />

<style>
body {font-family: ff-clan-web-pro, "Helvetica Neue", Helvetica, sans-serif !important;font-size: 12px;}
Expand Down
8 changes: 4 additions & 4 deletions examples/gallery/build-tools/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@

<meta name="description" content="WebGL-based visualization examples using deck.gl">

<link rel="icon" type="img/ico" href="https://uber.github.io/deck.gl/favicon.ico">
<link rel="icon" type="img/ico" href="https://visgl.github.io/deck.gl/favicon.ico">

<!-— facebook open graph tags -->
<meta property="og:url" content="https://uber.github.io/deck.gl/showcases/gallery" />
<meta property="og:url" content="https://visgl.github.io/deck.gl/showcases/gallery" />
<meta property="og:title" content="{{title}} | WebGL visualization" />
<meta property="og:description" content="WebGL-based visualization examples using deck.gl" />
<meta property="og:site_name" content="deck.gl" />
<meta property="og:image" content="https://uber.github.io/deck.gl/showcases/gallery/{{image}}" />
<meta property="og:image" content="https://visgl.github.io/deck.gl/showcases/gallery/{{image}}" />
<meta property="og:image:type" content="image/jpeg" />
<meta property="og:image:width" content="800" />
<meta property="og:image:height" content="480" />
Expand All @@ -25,7 +25,7 @@
<meta name="twitter:creator" content="@uber">
<meta name="twitter:title" content="{{title}} | WebGL visualization">
<meta name="twitter:description" content="WebGL-based visualization examples using deck.gl">
<meta name="twitter:image" content="https://uber.github.io/deck.gl/showcases/gallery/{{image}}" />
<meta name="twitter:image" content="https://visgl.github.io/deck.gl/showcases/gallery/{{image}}" />

<style>
body {font-family: ff-clan-web-pro, "Helvetica Neue", Helvetica, sans-serif !important; font-size: 12px;}
Expand Down
2 changes: 1 addition & 1 deletion modules/main/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A WebGL2-powered, highly performant framework for large-scale data visualization

[API Documentation](http://deck.gl/#/documentation)

[![docs](http://i.imgur.com/mvfvgf0.jpg)](https://uber.github.io/deck.gl)
[![docs](http://i.imgur.com/mvfvgf0.jpg)](https://visgl.github.io/deck.gl)

## Installation

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"lint": "ocular-lint",
"cover": "ocular-test cover",
"publish": "ocular-publish",
"start": "open http://uber.github.io/deck.gl/#/documentation/getting-started/installation?section=running-the-examples",
"start": "open http://visgl.github.io/deck.gl/#/documentation/getting-started/installation?section=running-the-examples",
"test": "ocular-test",
"test-fast": "ocular-test fast",
"test-node": "ocular-test node",
Expand Down
10 changes: 5 additions & 5 deletions showcases/graph/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ The GraphLayer example lays out and renders a force-directed network graph.
Two primary layers are implemented in this example:

### `graph-layer`
A ["collection layer"](http://uber.github.io/deck.gl/#/documentation/custom-layers/composite-layers) that delegates rendering to:
- a [ScatterplotLayer](http://uber.github.io/deck.gl/#/documentation/layer-catalog/scatterplot-layer)
- a [LineLayer](http://uber.github.io/deck.gl/#/documentation/layer-catalog/line-layer)
- (_optional_) a [IconLayer](http://uber.github.io/deck.gl/#/documentation/layer-catalog/icon-layer)
A ["collection layer"](http://visgl.github.io/deck.gl/#/documentation/custom-layers/composite-layers) that delegates rendering to:
- a [ScatterplotLayer](http://visgl.github.io/deck.gl/#/documentation/layer-catalog/scatterplot-layer)
- a [LineLayer](http://visgl.github.io/deck.gl/#/documentation/layer-catalog/line-layer)
- (_optional_) a [IconLayer](http://visgl.github.io/deck.gl/#/documentation/layer-catalog/icon-layer)

### `graph-layout-layer`
An ["adaptor layer"](http://uber.github.io/deck.gl/#/documentation/custom-layers/composite-layers) that links a layout (by default, `graph-simulation`, which uses [d3-force](https://github.com/d3/d3-force)) to the renderer.
An ["adaptor layer"](http://visgl.github.io/deck.gl/#/documentation/custom-layers/composite-layers) that links a layout (by default, `graph-simulation`, which uses [d3-force](https://github.com/d3/d3-force)) to the renderer.

To parse data into the format required by your layout, and to manage addition / removal of graph elements, use or write a graph "adaptor".
Currently, all three of [the existing adaptors](./graph-layer/adaptor) parse data into an array of `nodes` and `links`, but none yet offer support for addition/removal of nodes/links.
Expand Down
2 changes: 1 addition & 1 deletion website-gatsby/ocular-config.js
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ based maps.',
},
{
name: 'react-map-gl',
url: 'https://uber.github.io/react-map-gl'
url: 'https://visgl.github.io/react-map-gl'
},
{
name: 'react-vis',
Expand Down
6 changes: 3 additions & 3 deletions website/contents/links.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// TODO move to a GitHub file?
export default {
'deck.gl': 'https://uber.github.io/deck.gl',
'luma.gl': 'https://uber.github.io/luma.gl',
'react-map-gl': 'https://uber.github.io/react-map-gl',
'deck.gl': 'https://visgl.github.io/deck.gl',
'luma.gl': 'https://visgl.github.io/luma.gl',
'react-map-gl': 'https://visgl.github.io/react-map-gl',
'nebula.gl': 'https://nebula.gl/',
'react-vis': 'https://uber.github.io/react-vis',
'vis.gl': 'http://vis.gl'
Expand Down
2 changes: 1 addition & 1 deletion website/contents/pages.js
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ export const showcasePages = generatePath([
},
{
name: 'Wind Map',
external: 'http://uber.github.io/deck.gl/examples/wind'
external: 'http://visgl.github.io/deck.gl/examples/wind'
},
{
name: 'Ascii Video Player',
Expand Down
Loading

0 comments on commit c12fe94

Please sign in to comment.