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

Add more embedding info to docs #1243

Merged
merged 6 commits into from Nov 2, 2018

Conversation

Projects
None yet
3 participants
@garrettjstevens
Copy link
Contributor

garrettjstevens commented Oct 25, 2018

This adds more information about embedding and adds a section on using browser.bundle.js to embed JBrowse with a custom runtime-generated config.

I updated some of the embedding examples to make sure they'll actually work when published to the site, since they depend on the JBrowse that is installed on the server. You can see this in action live on a beta page I put of this doc page on the website: https://jbrowse.org/docstest/embedding.html

A couple oddities:

  • The loading screen div doesn't seem to get destroyed in the embedded div example
  • Is there a way to keep it from adding all the information to the URL of the page?
@garrettjstevens

This comment has been minimized.

Copy link
Contributor

garrettjstevens commented Oct 26, 2018

Notes from backlog grooming:

  • Loading div needs id, not just class
  • Check updateBrowserURL
@garrettjstevens

This comment has been minimized.

Copy link
Contributor

garrettjstevens commented Oct 28, 2018

@rbuels the "updateBrowserURL" config option wasn't working, but should be fixed now. I think this is good to merge now.

@rbuels

This comment has been minimized.

Copy link
Collaborator

rbuels commented Oct 29, 2018

@garrettjstevens could you add a little release note about this change to release_notes.md?

garrettjstevens and others added some commits Oct 29, 2018

@rbuels rbuels merged commit 26b41ad into dev Nov 2, 2018

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details

@wafflebot wafflebot bot removed the in progress label Nov 2, 2018

@rbuels rbuels deleted the more_embedding_docs branch Nov 6, 2018

@cmdcolin cmdcolin added this to the 1.16.0 milestone Dec 9, 2018

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