-
Notifications
You must be signed in to change notification settings - Fork 61
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
Various docs improvements #724
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/nextstrain/nextclade/2mbXvW88EKtUg7EvHL34FSxbovSG |
Since this has come up for the second time now, do you @ivan-aksamentov think we should write a few lines about downloading datasets behind a proxy? Downloading the files manually using |
@corneliusroemer I don't think it should be in the official docs. Or perhaps as a little note, with a link to GitHub issue, but definitely no official recommendations, especially that we cannot guarantee stability of the data GitHub repo, or even its existence, as well as stability of the index file format. I think we are also might be about to break the format soon (according to Richard's plans). |
@ivan-aksamentov yes was thinking the same, maybe a small note with link. But then it's not that common a use case so if the question comes up again, we can just link to the existing issues with up to date info on what the best workaround is right now. |
@corneliusroemer I find that some of the changes are overly focused on SARS-CoV-2. This is still the primary target right now, but we should consider a more generic approach to documenting things in the future. Or at least when you are taking about specific mutations, labels, clades etc., to mention that you are talking about a particular virus (I'd imagine language like "For example, in SARS-CoV-2", "In case of SARS-CoV-2", etc.). But right now it's not a big deal. Users are expected to have some understanding about the current situation in the field, so they should be able to recognize the virus. |
You're right, once SC2 is less preeminent, I'm happy to go through it and put any SC2 specifics in a box to separate from general parts. |
I've created an issue to separate out the SC2 specifics from the more generally valid parts: #729 |
Resolves #259