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

Update install docs #1610

Merged
merged 6 commits into from
Dec 7, 2022
Merged

Update install docs #1610

merged 6 commits into from
Dec 7, 2022

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Dec 5, 2022

(preview)

Description of proposed changes

Convert page to reST and update contents with more clear guidance.

Related issue(s)

Testing

This doc is no longer fetched by docs.nextstrain.org¹, so the warning is
no longer needed.

¹ nextstrain/docs.nextstrain.org@62e4a3a
Commands used:

    pandoc -f markdown -t rst --wrap=none docs/introduction/install.md -o docs/introduction/install.rst
    rm docs/introduction/install.md
@victorlin victorlin requested a review from a team December 5, 2022 23:00
@victorlin victorlin self-assigned this Dec 5, 2022
@nextstrain-bot nextstrain-bot temporarily deployed to auspice-victorlin-updat-2pri4e December 5, 2022 23:00 Inactive
docs/introduction/install.rst Outdated Show resolved Hide resolved
docs/introduction/install.rst Outdated Show resolved Hide resolved
docs/introduction/install.rst Outdated Show resolved Hide resolved
docs/introduction/install.rst Outdated Show resolved Hide resolved
- Add a link to the Nextstrain installation guide
- Add table of contents
- Split into "user" and "developer" sections
- Fix Conda environment setup command
- Remove note on bash/env requirement. Don't think it's necessary.
@victorlin victorlin force-pushed the victorlin/update-install-docs branch from 5c0f03a to 411324b Compare December 6, 2022 22:34
@nextstrain-bot nextstrain-bot temporarily deployed to auspice-victorlin-updat-2pri4e December 6, 2022 22:34 Inactive
Instead of having duplicate instructions getting out of sync.
@nextstrain-bot nextstrain-bot temporarily deployed to auspice-victorlin-updat-2pri4e December 6, 2022 22:36 Inactive
Copy link
Member

@jameshadfield jameshadfield left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from reading over the files 👍

@victorlin victorlin merged commit b3b9c52 into master Dec 7, 2022
@victorlin victorlin deleted the victorlin/update-install-docs branch December 7, 2022 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

4 participants