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.

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

Updates to quickstart guides #1435

Merged
merged 5 commits into from
Nov 13, 2020
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion products/jbrowse-desktop/doc/objectTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A configuration is a type of mobx-state-tree model, in which leaf nodes are Conf
Slot Slot
```

Configurations are all descendents of a single root configuration, which is `root.configuration`.
Configurations are all descendants of a single root configuration, which is `root.configuration`.

Configuration types should always be created by the `ConfigurationSchema` factory, e.g.

Expand Down
2 changes: 1 addition & 1 deletion website/blog/2020-11-05-jbrowse-web-1.0.0-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Changes
- fixed bug with reference sequences that don't use the alias system
- fixed bug with SV inspector having a disabled state stuck on the buttons
- added documentation for the `jbrowse admin-server` command
[here](/docs/quickstart_admin)
[here](/docs/quickstart_gui)
- added display modes, a giant effort to make the same track visible in
multiple contexts
- added a splash screen when no default session is in the config file
Expand Down
2 changes: 1 addition & 1 deletion website/docs/bcc2020_plugin_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,4 +214,4 @@ production

This is an initial look into jbrowse 2 plugin development. I strongly encourage
reading the developer guide in the main documentation for more info, and let us
know if you have any feeback or questions. Thanks!
know if you have any feedback or questions. Thanks!
10 changes: 5 additions & 5 deletions website/docs/config_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A JBrowse 2 configuration file, a config.json, is structured as follows
/* list of assembly configurations, e.g. the genomes being viewed */
],
"tracks": [
/* array of tracks being loaded, contain reference to which assembl(ies)
/* array of tracks being loaded, contain reference to which assembl(y/ies)
they belong to */
],
"defaultSession": {
Expand Down Expand Up @@ -78,7 +78,7 @@ Here is a complete config.json file containing only a hg19

## Configuring reference name aliasing

Reference name aliasing is a process to make chromosomes that are named slighlty
Reference name aliasing is a process to make chromosomes that are named slightly
differently but which refer to the same thing render properly

The refNameAliases in the above config provides this functionality
Expand Down Expand Up @@ -148,7 +148,7 @@ See our CLI docs for the add-assembly for more details here --

Note: assemblies can also be added graphically using the assembly manager when
you are using the so-called admin-server. See the [quickstart
guide](quickstart_admin#adding-an-assembly) for more details.
guide](quickstart_gui#adding-an-assembly) for more details.

## Assembly config

Expand Down Expand Up @@ -395,7 +395,7 @@ Example AlignmentsTrack config
#### BamAdapter configuration options

- bamLocation - a 'file location' for the BAM
- index: a subconfigurations chema containing
- index: a subconfiguration schema containing
- indexType: options BAI or CSI. default: BAI
- location: a 'file location' of the index

Expand Down Expand Up @@ -490,7 +490,7 @@ Example config
#### VcfTabixAdapter configuration options

- vcfGzLocation - a 'file location' for the BigWig
- index: a subconfigurations chema containing
- index: a subconfiguration schema containing
- indexType: options TBI or CSI. default TBI
- location: the location of the index

Expand Down
2 changes: 1 addition & 1 deletion website/docs/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,7 @@ ConfigSlot types, and other nodes are ConfigurationSchema types.
Slot Slot
```

Configurations are all descendents of a single root configuration, which is
Configurations are all descendants of a single root configuration, which is
`root.configuration`.

Configuration types should always be created by the `ConfigurationSchema`
Expand Down
Binary file added website/docs/img/admin_server.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/img/config_not_found.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/img/lgv_assembly.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/img/sample_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/img/volvox_alignments.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added website/docs/img/volvox_variants.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
126 changes: 0 additions & 126 deletions website/docs/quickstart_admin.md

This file was deleted.

Loading