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

Add blurb clarifying various project docs #172

Merged
merged 1 commit into from
May 26, 2020
Merged

Conversation

eharkins
Copy link
Contributor

Description of proposed changes

  1. Add a blurb making it clear what information should go in the nextstrain.org documentation vs augur, auspice.
  2. fix local static site build instructions. Despite my changes to the static site build instructions, I think this importing code from auspice-client/customisations into the static-site means we have to install the root repo node dependencies in addition to the static-site ones even if we just want to run the static site (i.e. if someone is following the instructions in the document in question here with a fresh clone). Although perhaps there is a way to set up node dependencies so this isn't necessary? If not we should change the instructions to something like npm ci && cd static-site && npm ci

Related issue(s)

#164

Testing

Locally with gatsby + testing links work

Thank you for contributing to Nextstrain!

also fix local docs build instructions
@tsibley tsibley temporarily deployed to nextstrain-s-docs-docum-btcuqm May 26, 2020 21:08 Inactive
@jameshadfield jameshadfield merged commit 53814e3 into master May 26, 2020
@jameshadfield jameshadfield deleted the docs-documentation branch May 26, 2020 23:10
@eharkins
Copy link
Contributor Author

Despite my changes to the static site build instructions, I think this importing code from auspice-client/customisations into the static-site means we have to install the root repo node dependencies in addition to the static-site ones even if we just want to run the static site (i.e. if someone is following the instructions in the document in question here with a fresh clone).

Given this, @jameshadfield and I have been discussing a good way to have the instructions until we have a better solution (see #158).

James suggests something along the lines of:

cd nextstrain.org
npm run install
npm run build # builds both auspice _and_ the static site
npm run server # see essentially a nextstrain.org clone

Along with a separate section for the dev server that says something like: “there’s a development server version as well, but it’s not perfect… here’s how you can use this”

@tsibley
Copy link
Member

tsibley commented May 27, 2020

👍 for the install + build + server approach. That's what I've always done locally, as running the two "apps" separately doesn't realistically test changes anyway. (It's also possible to setup automatic re-runs of the build + server steps when files change, which I've used from time to time instead of hot reloading.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants