Skip to content

Commit

Permalink
Create tutorial intro page using content from index pages
Browse files Browse the repository at this point in the history
  • Loading branch information
victorlin committed Mar 28, 2022
1 parent 31d18ad commit 59f808b
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 9 deletions.
10 changes: 3 additions & 7 deletions docs/src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,11 @@
A Getting Started Guide to the Genomic Epidemiology of SARS-CoV-2
*****************************************************************

This template and tutorial will walk you through the process of running a basic phylogenetic analysis on SARS-CoV-2 data.
We've created these resources with the goal of enabling Departments of Public Health to start using Nextstrain to understand their SARS-CoV-2 genomic data within 1-2 hours.
In addition to the phylogenetic analysis described here, you can use our "drag-and-drop" tool for a clade assignment, mutations calling, and basic sequence quality checks at `clades.nextstrain.org <https://clades.nextstrain.org/>`_.

If you prefer video format to working through this tutorial in the written documentation, check out the :doc:`video tutorial walkthrough <videos>`.
This is the documentation for the SARS-CoV-2 workflow maintained and actively used by the Nextstrain core team.

We also recommend `this 1-hour video overview <https://youtu.be/m4_F2tG58Pc>`_ by Heather Blankenship on how to deploy Nextstrain for a Public Health lab.
In addition to the phylogenetic analysis described here, you can use our "drag-and-drop" tool for a clade assignment, mutations calling, and basic sequence quality checks at `clades.nextstrain.org <https://clades.nextstrain.org/>`_.

If something in this tutorial is broken or unclear, please `open an issue <https://github.com/nextstrain/ncov/issues/new/choose>`_ so we can improve it for everyone.
If something in this documentation is broken or unclear, please `open an issue <https://github.com/nextstrain/ncov/issues/new/choose>`_ so we can improve it for everyone.

If you have a specific question, post a note over at the `discussion board <https://discussion.nextstrain.org/>`_ -- we're happy to help!

Expand Down
3 changes: 1 addition & 2 deletions docs/src/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
Tutorial
********

These tutorials will guide you to create a :term:`Nextstrain build <docs.nextstrain.org:build>` for genomic surveillance.

.. toctree::
:maxdepth: 1
:titlesonly:
:caption: Table of contents

intro
setup
running
17 changes: 17 additions & 0 deletions docs/src/tutorial/intro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Introduction
============

These tutorials will walk you through the process of running a basic genomic surveillance workflow using SARS-CoV-2 data.
We've created these resources with the goal of enabling Departments of Public Health to start using Nextstrain to understand their SARS-CoV-2 genomic data within 1-2 hours.

At the end, you will be able to:

- create phylogenetic trees of SARS-CoV-2 genomes from different sources including GISAID and Nextstrain-curated GenBank data
- visualize the resulting trees in :term:`docs.nextstrain.org:Auspice`
- define subsampling logic for your own genomic epidemiological analysis

After completing these tutorials, you may wish to `learn more about genomic epidemiology <link to Alli's gen epi book or some other resources?>`_ or `review all possible options to configure your SARS-CoV-2 analyses with Nextstrain <../reference/configuration.html>`_.

If you prefer video format to working through these written tutorials, check out the :doc:`video tutorial walkthrough <../videos>`.

We also recommend `this 1-hour video overview <https://youtu.be/m4_F2tG58Pc>`_ by Heather Blankenship on how to deploy Nextstrain for a Public Health lab.

0 comments on commit 59f808b

Please sign in to comment.