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.

Sign up for GitHub

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

Jump to bottom

Documentation fixes additions #21

Merged
merged 16 commits into from
Sep 12, 2020
Merged

Documentation fixes additions #21

merged 16 commits into from
Sep 12, 2020

Conversation

RaymondDashWu
Copy link
Collaborator

Created guide/tips for rendering Hubble exports to preferable formats for presentation such as GIF/MP4

chrisgervang
chrisgervang reviewed Aug 5, 2020
View reviewed changes
chrisgervang
chrisgervang reviewed Aug 5, 2020
View reviewed changes
docs/rendering-tip.md Outdated
@@ -1,2 +1,50 @@
# Rendering Tips
Hubble offers the following options to render your visualizations:
- GIF
- MP4
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think we can say MP4 is supported. Instead I think you could create a section for converting webm or a photo sequence into an mp4 using ffmpeg and/or one of those conversion websites.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suppose that's true for now. I put it in there for the case that I figured out how to make an MP4 that would natively play on Mac. Right now I know we could easily make another encoder for MP4 by switching L79 https://github.com/uber/hubble.gl/blob/6c044c423c43d37c62fd396fdd6f2a96c885a66a/modules/core/src/encoders/video/stream-encoder.js#L79 . Should I just remove it for now since this will be pushed to production on the Github pages?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we should only publish what we currently support.

I don’t think the StreamEncoder change is ideal, since it drops frames and has playback issues. It’s probably not a good idea to put it as the flagship MP4 encoder.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted. Will remove it for now

@chrisgervang
Copy link
Collaborator

To have this added to the website you’ll want to add it to the table of contents JSON. I’ll see if I can find it.

@chrisgervang
Copy link
Collaborator

https://github.com/uber/hubble.gl/blob/master/docs/table-of-contents.json

You can add an entry in Guide Book.

@RaymondDashWu
Copy link
Collaborator Author

https://github.com/uber/hubble.gl/blob/master/docs/table-of-contents.json

You can add an entry in Guide Book.

Done

@chrisgervang
Copy link
Collaborator

Awesome. Can you move the images to https://github.com/uber/hubble.gl/tree/master/website/static/images ? Otherwise, I don't think the doc server will be able to access them.

@RaymondDashWu
Copy link
Collaborator Author

Awesome. Can you move the images to https://github.com/uber/hubble.gl/tree/master/website/static/images ? Otherwise, I don't think the doc server will be able to access them.

Done

chrisgervang
chrisgervang reviewed Aug 7, 2020
View reviewed changes
docs/rendering-tip.md Outdated

**Step 6: Click on "Download the GIF"**

![GIFMaker Step 6](../website/static/images/gifmaker-step6.jpg)
Copy link
Collaborator

@chrisgervang chrisgervang Aug 7, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These URLs will be converted into HTML <a href=""/>, so they should be relative to where the server serves static assets. For example to link to, http://hubble.gl/images/visgl-logo.png I'd put ![Cool Image](/images/visgl-logo.png) in the markdown.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@chrisgervang chrisgervang merged commit a40aa18 into visgl:master Sep 12, 2020
chrisgervang referenced this pull request in CodeLabs-Hubble-gl/hubble.gl Sep 23, 2020
@chrisgervang @RaymondDashWu @dependabot
Upstream updates (#19)
9fec046 
* Upgrade packages, downgrade node (for now) (#14)

Pinning node to version 12.6.3 per discussion. Upgrading to deck 8.2.2

* Improve App Integration: Make Camera and Layers Optional in a DeckScene (#15)

* Minor keyframe class clean up, removing unused defaults

* Camera and Layers are optional in a DeckScene

- Animating the camera is optional, but if a keyframe is defined then viewState is controlled by camera keyframe.
  - To Use: do not provide a `camera` to `keyframes` parameter when constructing DeckScene.
- Animating layers is optional, only replace layers prop when scene provides layers.
  - To Use: do not provide a `renderLayers` parameter when constructing DeckScene

* Adding Camera Example to docs

* [FIX/ADD] Fixed missing steps to instructions + added extra notation (#13)

* [FIX/ADD] Fixed missing steps to instructions + added extra notation

* [FIX] Forgot missing step in #8

* [FIX/ADD] Fix step 9 and added clarification

* [DEL] Extraneous folders/files

* Adding a ResolutionGuide component to examples...(#17)

...so the background doesn't look so empty.

* v1.1.0-alpha.3 (#18)

* v1.1.0-alpha.4

* Bump lodash from 4.17.15 to 4.17.19

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](lodash/lodash@4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <[email protected]>

* Bump elliptic from 6.5.2 to 6.5.3

Bumps [elliptic](https://github.com/indutny/elliptic) from 6.5.2 to 6.5.3.
- [Release notes](https://github.com/indutny/elliptic/releases)
- [Commits](indutny/elliptic@v6.5.2...v6.5.3)

Signed-off-by: dependabot[bot] <[email protected]>

* lint (#28)

* v1.1.0-alpha.5

* Documentation fixes additions (#21)

* [FIX/ADD] Fixed missing steps to instructions + added extra notation

* [FIX] Forgot missing step in #8

* [FIX/ADD] Fix step 9 and added clarification

* [DEL] Extraneous folders/files

* [TEST] Is this how you link markdown images?

* [ADD] Rendering tips/guide

* [FIX] Separated GIF/MP4 so it can't be interpreted together

* [FIX] Made steps more clear by bolding and fixed sequence conversion to gif not mp4

* [FIX?] Image not loading

* [FIX] MP4 => GIF error

* [FIX] Spacing between Step #s

* [FIX] Step #4 spacing

* [FIX/ADD] Removed MP4 from docs + added entry to table of contents

* [MOVE] Images move to website static folder + location updated

* [FIX] Image URLS

* Bump http-proxy from 1.18.0 to 1.18.1 (#25)

Bumps [http-proxy](https://github.com/http-party/node-http-proxy) from 1.18.0 to 1.18.1.
- [Release notes](https://github.com/http-party/node-http-proxy/releases)
- [Changelog](https://github.com/http-party/node-http-proxy/blob/master/CHANGELOG.md)
- [Commits](http-party/node-http-proxy@1.18.0...1.18.1)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump node-fetch from 2.6.0 to 2.6.1 (#26)

Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1.
- [Release notes](https://github.com/bitinn/node-fetch/releases)
- [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md)
- [Commits](node-fetch/node-fetch@v2.6.0...v2.6.1)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Co-authored-by: RaymondDashWu <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
RaymondDashWu pushed a commit to RaymondDashWu/hubble.gl that referenced this pull request Nov 3, 2020
@chrisgervang
Merge pull request visgl#21 from CodeLabs-Hubble-gl/chrisgervang-patch-1
2850127 
Update deck-scene.js
RaymondDashWu added a commit to RaymondDashWu/hubble.gl that referenced this pull request Nov 3, 2020
@RaymondDashWu @chrisgervang
@dependabot @97morningstar
Kepler Integration example with Hubble button. Allows users to export…
cc491fe 
… an animation for some datasets (visgl#15)

* Upgrade packages, downgrade node (for now) (visgl#14)

Pinning node to version 12.6.3 per discussion. Upgrading to deck 8.2.2

* Improve App Integration: Make Camera and Layers Optional in a DeckScene (visgl#15)

* Minor keyframe class clean up, removing unused defaults

* Camera and Layers are optional in a DeckScene

- Animating the camera is optional, but if a keyframe is defined then viewState is controlled by camera keyframe.
  - To Use: do not provide a `camera` to `keyframes` parameter when constructing DeckScene.
- Animating layers is optional, only replace layers prop when scene provides layers.
  - To Use: do not provide a `renderLayers` parameter when constructing DeckScene

* Adding Camera Example to docs

* [FIX/ADD] Fixed missing steps to instructions + added extra notation (visgl#13)

* [FIX/ADD] Fixed missing steps to instructions + added extra notation

* [FIX] Forgot missing step in visgl#8

* [FIX/ADD] Fix step 9 and added clarification

* [DEL] Extraneous folders/files

* Adding a ResolutionGuide component to examples...(visgl#17)

...so the background doesn't look so empty.

* v1.1.0-alpha.3 (visgl#18)

* v1.1.0-alpha.4

* Bump lodash from 4.17.15 to 4.17.19

Bumps [lodash](https://github.com/lodash/lodash) from 4.17.15 to 4.17.19.
- [Release notes](https://github.com/lodash/lodash/releases)
- [Commits](lodash/lodash@4.17.15...4.17.19)

Signed-off-by: dependabot[bot] <[email protected]>

* Bump elliptic from 6.5.2 to 6.5.3

Bumps [elliptic](https://github.com/indutny/elliptic) from 6.5.2 to 6.5.3.
- [Release notes](https://github.com/indutny/elliptic/releases)
- [Commits](indutny/elliptic@v6.5.2...v6.5.3)

Signed-off-by: dependabot[bot] <[email protected]>

* Initial commit. Mini kepler example but not connected to Redux

* [BLOCKED] Can't connect to Kepler's Redux store

* [BLOCKED] Can't connect to Redux

* lint (visgl#28)

* v1.1.0-alpha.5

* Documentation fixes additions (visgl#21)

* [FIX/ADD] Fixed missing steps to instructions + added extra notation

* [FIX] Forgot missing step in visgl#8

* [FIX/ADD] Fix step 9 and added clarification

* [DEL] Extraneous folders/files

* [TEST] Is this how you link markdown images?

* [ADD] Rendering tips/guide

* [FIX] Separated GIF/MP4 so it can't be interpreted together

* [FIX] Made steps more clear by bolding and fixed sequence conversion to gif not mp4

* [FIX?] Image not loading

* [FIX] MP4 => GIF error

* [FIX] Spacing between Step #s

* [FIX] Step visgl#4 spacing

* [FIX/ADD] Removed MP4 from docs + added entry to table of contents

* [MOVE] Images move to website static folder + location updated

* [FIX] Image URLS

* Bump http-proxy from 1.18.0 to 1.18.1 (visgl#25)

Bumps [http-proxy](https://github.com/http-party/node-http-proxy) from 1.18.0 to 1.18.1.
- [Release notes](https://github.com/http-party/node-http-proxy/releases)
- [Changelog](https://github.com/http-party/node-http-proxy/blob/master/CHANGELOG.md)
- [Commits](http-party/node-http-proxy@1.18.0...1.18.1)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* [BLOCKED] Issues in visgl#12 Codelabs

* [FIX] Modal now opens

* Bump node-fetch from 2.6.0 to 2.6.1 (visgl#26)

Bumps [node-fetch](https://github.com/bitinn/node-fetch) from 2.6.0 to 2.6.1.
- [Release notes](https://github.com/bitinn/node-fetch/releases)
- [Changelog](https://github.com/node-fetch/node-fetch/blob/master/docs/CHANGELOG.md)
- [Commits](node-fetch/node-fetch@v2.6.0...v2.6.1)

Signed-off-by: dependabot[bot] <[email protected]>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* [BLOCKED] Can't find module ocular.config

* [FIX] Webpack config now boots start-local

* [FIX] Modal now opens with map but animations bugged

* Documentation Grammer Edit (visgl#29)

Just a missing comma

* [ADD] Incorporated initial view state + default/update keyframes

* [FIX] Updated keyframes were wrong bug

* [REFACTOR] Created new panel-preview + scene now consistent with hubble's scene

* Mapbox And Deck.gl Canvas Merged When Exported With Hubble.gl In Example Trips (visgl#31)

* Mapbox and Deck.gl canvas merged when exported with Hubble.gl

Co-authored-by: Chris Gervang <[email protected]>

* [FIX] updateCamera temporary fix

* [FIX/REFACTOR] updateCamera now updates keyframe, parseSetCameraType now a generic util

* [FIX/CLEAN] Bug where keyframes weren't updating properly + cleaned dead code in preparation to merge to master

* [CLEAN] Removed unused code, packages, + lint fixes

Co-authored-by: Chris Gervang <[email protected]>
Co-authored-by: Chris Gervang <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Chris Gervang <[email protected]>
Co-authored-by: Vitor Dino <[email protected]>
Co-authored-by: Elisa Martinez <[email protected]>
@RaymondDashWu RaymondDashWu deleted the documentation-fixes-additions branch January 6, 2021 03:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chrisgervang chrisgervang chrisgervang approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@RaymondDashWu @chrisgervang