search

GMOD / Apollo3

JBrowse 2 plugin for editing annotations on an Apollo server
Apache License 2.0
7 stars 4 forks source link

Data setup documentation #373

Open garrettjstevens opened 6 months ago

garrettjstevens commented 6 months ago

Now that we have deployment documentation in #372, we need to document (and also in some cases do some development) how users add assemblies, annotations, and evidence tracks. We'll need to document this process for users who want to do it via the CLI and for those who want to use the UI.

For setting up assemblies and annotations in the UI, we have a pretty established workflow, so mostly what's left there is to document it. For setting up assemblies and annotations from the CLI, we have commands that do that as well. It might be good to flesh out the "description" of the various flags and args in the CLI command classes, as well as adding some "examples" to the command classes (as seen here).

Adding evidence tracks is where we need to finalize some more things. One workflow that @kyostiebi has started working on is selecting a track that was added as a session track to JBrowse in the UI and then copying that to the config.json on the collaboration server. This is fine if the track points to a publicly hosted URL, but if the user wants to upload an evidence track file to the server, how do we deal with that?

Similarly, how do we add evidence tracks from the CLI? We can, for example, create a config.json and use the JBrowse CLI to add the evidence tracks to it, and then copy over the track configs to the collaboration server. But how do we make sure the files are in the right place on the server? And if the site admin has to use the JBrowse CLI and the Apollo CLI on the remote server, should that be part of one of the Docker containers in the existing compose.yml, or should it be something separate?

@kyostiebi @dariober @shashankbrgowda feel free to approach this and split it up however you like, and let me know if you need anything from me and I'll see it when I'm back next week.

garrettjstevens commented 6 months ago

@kyostiebi @dariober @shashankbrgowda any updates from your discussion last week?

shashankbrgowda commented 6 months ago

@kyostiebi @dariober @shashankbrgowda any updates from your discussion last week?

Documented steps to upload assembly, import features and delete an assembly. https://github.com/GMOD/Apollo3/pull/376

dariober commented 6 months ago

I prepared this but the PR is failing https://github.com/GMOD/Apollo3/pull/374