Skip to content

Commit

Permalink
fix some broken links in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jameshadfield authored and joachimschmidt557 committed Mar 21, 2020
1 parent edbe88c commit 9f27436
Show file tree
Hide file tree
Showing 8 changed files with 17 additions and 14 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
title: Changelog
---

## version 2.8.1 - 2020/03/20


* Fix bug in dependencies which could prevent auspice from being built

## version 2.8.0 - 2020/03/20
Expand Down
4 changes: 2 additions & 2 deletions docs-src/docs/customise-client/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ auspice build --extend <JSON>

## Available Customisations
The following are definable as top-level keys of the JSON file.
A useful reference may be the [customisation JSON file](https://github.com/nextstrain/nextstrain.org/blob/master/auspice/client/config.json) used by nextstrain.org.
A useful reference may be the [customisation JSON file](https://github.com/nextstrain/nextstrain.org/blob/master/auspice-client/customisations/config.json) used by nextstrain.org.

* `sidebarTheme` allows modifications to the aesthetics of the sidebar. See below.
* `navbarComponent` a (relative) path to a JS file exporting a React component to be rendered as the nav bar. See below.
Expand Down Expand Up @@ -128,4 +128,4 @@ This is using the default server address of "/charon".
This can be changed by specifying `serverAddress` in the customisation JSON.

> Note that currently you can't specify a different domain due to CORS headers.
This may well be a simple fix -- please get in touch if you can help here!
This may well be a simple fix -- please get in touch if you can help here!
2 changes: 1 addition & 1 deletion docs-src/docs/customise-client/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This is achieved by providing a JSON at build time to Auspice which defines the
auspice build --extend <JSON>
```

[Here's](https://github.com/nextstrain/nextstrain.org/blob/master/auspice/client/config.json) the file used by nextstrain.org to change the appearance of Auspice in the above image.
[Here's](https://github.com/nextstrain/nextstrain.org/blob/master/auspice-client/customisations/config.json) the file used by nextstrain.org to change the appearance of Auspice in the above image.


See the [client customisation API](customise-client/api.md) for the available options.
Expand Down
6 changes: 3 additions & 3 deletions docs-src/docs/introduction/how-to-run.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,9 @@ Auspice takes two different file types: datasets (the tree, map, etc.), which ar
### Dataset JSONs

For datasets, Auspice (v2.x) can currently load either
* "Auspice v1" JSONs (metadata + tree JSONs) -- see the JSON schemas [here](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v1-meta.json) and [here](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v1-tree.json).
* "Auspice v1" JSONs (metadata + tree JSONs) -- see the JSON schemas [here](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v1-meta.json) and [here](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v1-tree.json).
_The zika dataset we download above is in this format_
* "Auspice v2" JSONs. See the JSON schema [here](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v2.json).
* "Auspice v2" JSONs. See the JSON schema [here](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v2.json).

See the [Server API](server/api.md) for more details about the file formats an Auspice server (e.g. `auspice view`) sends to the client.

Expand All @@ -104,4 +104,4 @@ If you'd like to download the datasets and narratives on [nextstrain.org](https:
* You can download the dataset JSONs by running [this script](https://github.com/nextstrain/auspice/blob/master/scripts/get-data.sh) which will create a `./data` directory for you.
* You can download the narrative Markdown files by running [this script](https://github.com/nextstrain/auspice/blob/master/scripts/get-narratives.sh) which will create a `./narratives` directory for you.

You can then run `auspice view --datasetDir data --narrativeDir narratives` to visualise all of the [nextstrain.org](https://nextstrain.org) datasets locally.
You can then run `auspice view --datasetDir data --narrativeDir narratives` to visualise all of the [nextstrain.org](https://nextstrain.org) datasets locally.
6 changes: 3 additions & 3 deletions docs-src/docs/releases/v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ We've settled on a new single "v2" JSON, containing pretty similar information t
| file | schema | auspice versions | description |
| ---- | ---- | ---- | ---- |
|"tree" JSON | [Link](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v1-tree.json) | v1, v2 | Decorated phylogenetic tree |
|"meta" JSON | [Link](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v1-meta.json) | v1, v2 | The "metadata" associated with a phylogenetic tree |
|"v2" JSON | [Link](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v2.json) | v2 | The single input format required for Auspice v2 |
|"tree" JSON | [Link](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v1-tree.json) | v1, v2 | Decorated phylogenetic tree |
|"meta" JSON | [Link](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v1-meta.json) | v1, v2 | The "metadata" associated with a phylogenetic tree |
|"v2" JSON | [Link](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v2.json) | v2 | The single input format required for Auspice v2 |

If you use Augur to construct your JSONs, then the next version of Augur (v6) will give you the option to produce "v1" or "v2" JSONs.
If you have specific queries, the JSON schemas (above) should help you out, but here is a list of the main changes (with links to PRs where relevent, if you're _really_ keen!):
Expand Down
6 changes: 3 additions & 3 deletions docs-src/docs/server/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Failure to return a valid JSON will result in a warning notification shown in Au

The JSON response depends on the file-type being requested.

If the type is not specified, i.e. we're requesting the "main" dataset JSON then [see this JSON schema](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v2.json).
If the type is not specified, i.e. we're requesting the "main" dataset JSON then [see this JSON schema](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v2.json).
Note that the Auspice client _cannot_ process v1 (meta / tree) JSONs -- [see below](server/api.md#importing-code-from-auspice) for how to convert these.

Alternative file type reponses are to be documented.
Expand Down Expand Up @@ -100,7 +100,7 @@ The provided JavaScript file must export three functions, each of which handles

For information about the `req` and `res` arguments see the express documentation for the [request object](https://expressjs.com/en/api.html#req) and [response object](https://expressjs.com/en/api.html#res), respectively.

You can see [nextstrain.org](https://nextstrain.org)'s implementation of these handlers [here](https://github.com/nextstrain/nextstrain.org/blob/master/auspice/server/index.js).
You can see [nextstrain.org](https://nextstrain.org)'s implementation of these handlers [here](https://github.com/nextstrain/nextstrain.org/blob/master/server.js).

Here's a pseudocode example of an implementation for the `getAvailable` handler which may help understanding:

Expand Down Expand Up @@ -141,7 +141,7 @@ where `tree` is the v1 tree JSON, and `meta` the v1 meta JSON.

**Returns:**

An object representing the v2 JSON [defined by this schema](https://github.com/nextstrain/augur/blob/v6/augur/data/schema-export-v2.json).
An object representing the v2 JSON [defined by this schema](https://github.com/nextstrain/augur/blob/master/augur/data/schema-export-v2.json).



Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "auspice",
"version": "2.8.0",
"version": "2.8.1",
"description": "Web app for visualizing pathogen evolution",
"author": "James Hadfield, Trevor Bedford and Richard Neher",
"license": "AGPL-3.0-only",
Expand Down
2 changes: 1 addition & 1 deletion src/version.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const version = "2.8.0";
const version = "2.8.1";

module.exports = {
version
Expand Down

0 comments on commit 9f27436

Please sign in to comment.