diff --git a/docs/source/getting-started/collecting-data.rst b/docs/source/getting-started/collecting-data.rst index dc677ef31b..fc104b3d95 100644 --- a/docs/source/getting-started/collecting-data.rst +++ b/docs/source/getting-started/collecting-data.rst @@ -1,7 +1,7 @@ Collecting data =============== -Now that you've installed Augur's application server, it's time to configure your data collection workers. If you just want to run Augur using the single repository in the default database, and default worker settings all you need to do is this: +Now that you’ve installed Augur’s application server, it’s time to configure your data collection workers. If you just want to run Augur using the one repository in the default database, and default worker settings, all you need to do is this: .. code-block:: bash diff --git a/docs/source/getting-started/command-line-interface/backend.rst b/docs/source/getting-started/command-line-interface/backend.rst index f3bcab3a8b..7c614a8b37 100644 --- a/docs/source/getting-started/command-line-interface/backend.rst +++ b/docs/source/getting-started/command-line-interface/backend.rst @@ -16,7 +16,7 @@ This command is for starting Augur's API server & (optionally) data collection w --skip-cleanup Flag that disables the old process cleanup that runs before Augur starts. Useful for Python scripts where Augur needs to be run in the background: see the `test/api/runner.py` file for an example. -**To start the backend as normal:** +**To start the backend normally:** .. code-block:: diff --git a/docs/source/getting-started/command-line-interface/configure.rst b/docs/source/getting-started/command-line-interface/configure.rst index 3c9761e1c2..d0d21fe7ba 100644 --- a/docs/source/getting-started/command-line-interface/configure.rst +++ b/docs/source/getting-started/command-line-interface/configure.rst @@ -28,7 +28,7 @@ Below is the list of available parameters, their defaults, and the corresponding --rc-config-file Path to an existing Augur config file whose values will be used as the defaults. Defaults to ``None``. This parameter does not support being set by an environment variable. ---write-to-src Flag for writing the generated config file to the source code tree, instead of the default ``$HOME/.augur``. For developer use only. Defaults to ``False``. +--write-to-src Flag for writing the generated config file to the source code tree, instead of the default ``$HOME/.augur``. For developers use only. Defaults to ``False``. Example usage\: diff --git a/docs/source/getting-started/installation.rst b/docs/source/getting-started/installation.rst index 91e04b31e8..4c1b341948 100644 --- a/docs/source/getting-started/installation.rst +++ b/docs/source/getting-started/installation.rst @@ -92,6 +92,7 @@ Installation Now you're ready to build! The steps below outline how to create a virtual environment (**required**) and start the installation process, after which you'll move on to the next section to configure the workers. The instructions are written in a way that you can follow for your respective Operating System. + .. note:: Lines that start with a ``$`` denote a command that needs to run in an interactive terminal. diff --git a/docs/source/getting-started/toc.rst b/docs/source/getting-started/toc.rst index 66986c3a88..20ee7fa60a 100644 --- a/docs/source/getting-started/toc.rst +++ b/docs/source/getting-started/toc.rst @@ -2,13 +2,14 @@ Getting Started ================== -This section of the documentation is an entry-level walkthrough of the Augur project. By the end, you'll hopefully have a fully functioning local installation of Augur ready to collect data. +This section of the documentation is a no work experience required walkthrough of the Augur project. By the end, you’ll hopefully have a fully functioning local installation of Augur ready to collect data. + +If you want to get started as fast as possible, we have `Docker images <../docker/toc.html>`_; however, if you’re looking to use Augur for long-term data collection or if you want to install it for development, you’ll need to follow this walkthrough. -If you want to get started as fast as possible, we have `Docker images <../docker/toc.html>`_; however, if you're looking to use Augur for long-term data collection or if you want to install it for development, you'll need to follow this walkthrough. .. note:: - We currently officially support local installation of Augur from source on macOS, Ubuntu, and Fedora (but most UNIX-like systems will probably work with a few tweaks). If you are using Windows, we recommend either using the Docker images or setting up a virtual machine with a supported operating system installed. + We currently officially support the local installation of Augur from source on macOS, Ubuntu, and Fedora (but most UNIX-like systems will probably work with a few tweaks). We recommend either using the Docker images or setting up a virtual machine with a supported operating system installed if you are using Windows. To install from source, we'll need to do a few things: