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.

Sign up for GitHub

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

Resolving Issue #1857; Make the texts in the doc more inclusive. #1858

Merged
merged 3 commits into from
Jun 11, 2022
Merged

Resolving Issue #1857; Make the texts in the doc more inclusive. #1858

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5254e2c
Editted the toc.html part of the Getting Started doc to include inclu…
Preshh0 Jun 10, 2022
5977785
Editted installation.rst, so the note section displays properly.
Preshh0 Jun 10, 2022
4217d2f
Made few edits to text in some files.
Preshh0 Jun 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/getting-started/collecting-data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/command-line-interface/backend.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting-started/command-line-interface/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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\:

Expand Down
1 change: 1 addition & 0 deletions docs/source/getting-started/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
7 changes: 4 additions & 3 deletions docs/source/getting-started/toc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down