Skip to content

Tricky version mismatch in docs for local demo #745

@dariober

Description

@dariober

I think there's a tricky bug in the docs for setting up a local demo.

The provided compose.yml is hard-coded with jbrowse and apollo versions, currently jbrowse-web-v2.18.0 and jbrowse-plugin-apollo-0.3.4. However, the npm commands for installing apollo and jbrowse get the latest versions, currently jbrowse 3.7.0 and apollo 0.3.10. This means that the cli commands run successfully but the UI is not updated accordingly and there are no errors in either the cli or ui.

Somewhat related, once the user fixes the versions in compose.yml and runs docker compose up, it is necessary to clear the cache in the browser for the new versions to be picked up. In Chrome the command "Empty cache and hard reload" should do the trick, but it can be difficult to find out and remember.

Perhaps it would be good to have "Troubleshooting/FAQ" docs with these and maybe also the commands to clear the docker components related to Apollo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions