From 707f563aab0a62e0504e393af0cd23da3e4504e0 Mon Sep 17 00:00:00 2001 From: james hadfield Date: Tue, 24 Mar 2020 13:41:00 +1300 Subject: [PATCH] minor docs updates --- DEV_DOCS.md | 4 ++-- README.md | 2 +- docs-src/docs/introduction/install.md | 13 +++++++------ docs-src/docs/introduction/overview.md | 2 +- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/DEV_DOCS.md b/DEV_DOCS.md index 39db851c6..68f882753 100644 --- a/DEV_DOCS.md +++ b/DEV_DOCS.md @@ -17,9 +17,9 @@ For pull requests, please use [eslint](https://eslint.org/) as much as possible ## Contributing to Documentation -This documentation is all contained within the Auspice GitHub repo -- see [the README](https://github.com/nextstrain/auspice/tree/master/docs-src) within the `docs-src` directory for more details and instructions on how to contribute. +Nextstrain documentation is available at [nextstrain.github.io/auspice/](https://nextstrain.github.io/auspice/). -Please see [docs-src/README](./docs-src/README.md) for how the auspice documentation site is built. +This documentation is built from files contained within the Auspice GitHub repo -- see [the docs-src/README](https://github.com/nextstrain/auspice/tree/master/docs-src) within the `docs-src` directory for more details and instructions on how to contribute. Note that currently the documentation must be rebuilt & pushed to GitHub _after_ a new version is released in order for the changelog to correctly appear at [nextstrain.github.io/auspice/releases/changelog](https://nextstrain.github.io/auspice/releases/changelog). diff --git a/README.md b/README.md index b4110b87d..5f1d803af 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,6 @@ Full documentation may be found at: [nextstrain.github.io/auspice](https://nexts ## License and copyright -Copyright 2014-2019 Trevor Bedford and Richard Neher. +Copyright 2014-2020 Trevor Bedford and Richard Neher. Source code to Nextstrain is made available under the terms of the [GNU Affero General Public License](LICENSE.txt) (AGPL). Nextstrain is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. diff --git a/docs-src/docs/introduction/install.md b/docs-src/docs/introduction/install.md index 781703b6e..6e497d102 100644 --- a/docs-src/docs/introduction/install.md +++ b/docs-src/docs/introduction/install.md @@ -49,21 +49,22 @@ We're going to assume that you have used Conda to install Node.js as above. conda activate auspice # grab the GitHub auspice repo -git checkout https://github.com/nextstrain/auspice.git +git clone https://github.com/nextstrain/auspice.git cd auspice -# install dependencies -npm install - -# make `auspice` available globally +# install dependencies and make `auspice` available globally npm install --global . -# build auspice +# build auspice (builds the JS client bundle using webpack) auspice build # test it works auspice --version auspice --help + +# Obtain datasets & narratives to view locally (optional) +npm run get-data +npm run get-narratives ``` Updating Auspice should only require pulling the new version from GitHub -- it shouldn't require any `npm` commands. diff --git a/docs-src/docs/introduction/overview.md b/docs-src/docs/introduction/overview.md index b7bf36b5a..54cb09655 100644 --- a/docs-src/docs/introduction/overview.md +++ b/docs-src/docs/introduction/overview.md @@ -27,6 +27,6 @@ For a more formal introduction to auspice & the wider nextstrain project, please ## License and Copyright -Copyright © 2014-2019 Trevor Bedford and Richard Neher. +Copyright © 2014-2020 Trevor Bedford and Richard Neher. Source code to Nextstrain is made available under the terms of the [GNU Affero General Public License](LICENSE.txt) (AGPL). Nextstrain is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.