From 9f27436782efd2b3592702933a916e2b0fba4573 Mon Sep 17 00:00:00 2001 From: james hadfield Date: Fri, 20 Mar 2020 17:31:53 +1300 Subject: [PATCH] fix some broken links in documentation --- CHANGELOG.md | 3 +++ docs-src/docs/customise-client/api.md | 4 ++-- docs-src/docs/customise-client/introduction.md | 2 +- docs-src/docs/introduction/how-to-run.md | 6 +++--- docs-src/docs/releases/v2.md | 6 +++--- docs-src/docs/server/api.md | 6 +++--- package.json | 2 +- src/version.js | 2 +- 8 files changed, 17 insertions(+), 14 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c659b88d..d0b50f5d3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/docs-src/docs/customise-client/api.md b/docs-src/docs/customise-client/api.md index ead852292..95c7ffcbf 100644 --- a/docs-src/docs/customise-client/api.md +++ b/docs-src/docs/customise-client/api.md @@ -21,7 +21,7 @@ auspice build --extend ## 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. @@ -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! \ No newline at end of file +This may well be a simple fix -- please get in touch if you can help here! diff --git a/docs-src/docs/customise-client/introduction.md b/docs-src/docs/customise-client/introduction.md index 1c43e8027..4bccf9bc3 100644 --- a/docs-src/docs/customise-client/introduction.md +++ b/docs-src/docs/customise-client/introduction.md @@ -16,7 +16,7 @@ This is achieved by providing a JSON at build time to Auspice which defines the auspice build --extend ``` -[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. diff --git a/docs-src/docs/introduction/how-to-run.md b/docs-src/docs/introduction/how-to-run.md index 71ed290d0..47f98c070 100644 --- a/docs-src/docs/introduction/how-to-run.md +++ b/docs-src/docs/introduction/how-to-run.md @@ -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. @@ -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. \ No newline at end of file +You can then run `auspice view --datasetDir data --narrativeDir narratives` to visualise all of the [nextstrain.org](https://nextstrain.org) datasets locally. diff --git a/docs-src/docs/releases/v2.md b/docs-src/docs/releases/v2.md index c0ca0e467..ab0942e5b 100644 --- a/docs-src/docs/releases/v2.md +++ b/docs-src/docs/releases/v2.md @@ -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!): diff --git a/docs-src/docs/server/api.md b/docs-src/docs/server/api.md index 02b274811..94dd91c20 100644 --- a/docs-src/docs/server/api.md +++ b/docs-src/docs/server/api.md @@ -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. @@ -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: @@ -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). diff --git a/package.json b/package.json index eeeaef61d..94ba46e7f 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/src/version.js b/src/version.js index 31d7b5704..40c5bf933 100644 --- a/src/version.js +++ b/src/version.js @@ -1,4 +1,4 @@ -const version = "2.8.0"; +const version = "2.8.1"; module.exports = { version