Updates to quickstart guides #1435
Conversation
Co-authored-by: Teresa Martinez <tere486martinez@gmail.com> Co-authored-by: Peter Xie <peterkxie@yahoo.com> Co-authored-by: Elliot Hershberg <eahershberg@gmail.com>
garrettjstevens
requested review from
cmdcolin,
elliothershberg,
peterkxie and
teresam856
|  | ||
|
|
||
| ## Conclusion | ||
|
|
There was a problem hiding this comment.
Really like the flow of this quickstart!
|
I would prefer the CLI one gets rolled into the web quick-start, and the admin-server keeps being called admin-server guide |
|
The comment says "The proposed flow is to have three guides." but there are four now, and I think that adding tracks via the CLI is a logical extension to the web quick start |
Codecov Report
@@ Coverage Diff @@
## master #1435 +/- ##
==========================================
+ Coverage 59.58% 59.63% +0.04%
==========================================
Files 425 425
Lines 18990 18990
Branches 4442 4445 +3
==========================================
+ Hits 11316 11325 +9
+ Misses 7384 7376 -8
+ Partials 290 289 -1
Continue to review full report at Codecov.
|
Sorry, should have been clearer. I meant that the two guides we looked at would be split into three guides. We didn't look at the desktop guide. |
| files. See [configuring assemblies](config_guide#assembly-config) for more info | ||
| on formats supported for the sequence file. | ||
|
|
||
| :::note |
There was a problem hiding this comment.
I like the restructuring here
|
|
||
| If you have your JBrowse 2 | ||
| [running as described](quickstart_web#running-jbrowse-2) in the JBrowse web | ||
| quickstart, you can refresh the page and an add a linear genome view of the |
There was a problem hiding this comment.
For these kind of descriptions, is it worth adding the path in the menu? I.e. add a linear genome view (File -> Add -> Linear Genome View)
While pairing with each of @teresam856, @peterkxie, and @elliothershberg yesterday, we went through an exercise of trying to approach JBrowse from the point of view of someone who is brand new to it. While doing so, we made some proposed changes to the quickstart guides.
The proposed flow is to have three guides. First is the general quickstart which installs the JBrowse CLI, downloads JBrowse, and makes sure it's working. The users then have the choice to proceed with configuring JBrowse by using the CLI config quickstart or the GUI config quickstart.
This also adjust some formatting and wording and adds some screenshots so users can confirm that what they've done is successful.