Skip to content

Commit

Permalink
minor docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
jameshadfield committed Mar 24, 2020
1 parent 3292898 commit 707f563
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions DEV_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
13 changes: 7 additions & 6 deletions docs-src/docs/introduction/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs-src/docs/introduction/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 707f563

Please sign in to comment.