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

link out instructions from defining clades doc to augur docs #170

Closed
wants to merge 1 commit into from

Conversation

eharkins
Copy link
Contributor

Description of proposed changes

  1. Replace the defining clades tutorial with links to defining clades faq page in augur and to the augur docs tb tutorial as an example of how to export clade information.
  2. Move the defining clades doc to the bioinformatics section from the tutorials section
  3. Remove some unused docs images

I removed a solid chunk of explanation about defining clades from the nextstrain.org defining clades page, not all of which is made up for in a one-to-one way in the linked pages that replace
it. We should make sure no valuable information was lost and if it was to include it in the augur pages.

Related issue(s)

#164

Testing

Locally with gatsby

Thank you for contributing to Nextstrain!

also remove unused images
@jameshadfield jameshadfield temporarily deployed to nextstrain-s-docs-defin-j8bqjh May 24, 2020 23:54 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.

@eharkins finally getting around to this. After the changes of #195 do you think the best path forward would be to add any necessary information to augur's "defining clades" page, and then remove the tutorial currently found on nextstrain.org? We can add a redirect and an external link in the bioinformatics section of the nextstrain.org/docs sidebar.

@eharkins
Copy link
Contributor Author

@jameshadfield sorry for the delay!

After the changes of #195 do you think the best path forward would be to add any necessary information to augur's "defining clades" page, and then remove the tutorial currently found on nextstrain.org? We can add a redirect and an external link in the bioinformatics section of the nextstrain.org/docs sidebar.

That makes sense to me for now, although it seems there is some information re: interacting with clades in the UI that feels like it belongs more in nextstrain.org (perhaps in /help) or auspice docs than in augur:

Then, head back to the tree. When you hover over a branch in the tree, a dark grey window pops up. Inside this window, you’ll see that there’s a header that says Nucleotide Mutations:. In the image below, the clade descended from this branch is defined by a mutation from G to A at site 9417 in the genome. This is the information that you’ll need for defining your clades.

This is a good example of a concept that touches multiple parts of the nextstrain stack - so long term it will probably fit best located at the top level of our docs, adjacent to, instead of within docs headings about augur or auspice.

I'm happy to submit a PR merging them into augur docs for now.

@eharkins
Copy link
Contributor Author

Moved to nextstrain/docs.nextstrain.org#35

@eharkins eharkins closed this Oct 26, 2020
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.

2 participants