Merge branch 'main' into Preshh0-patch-10

README.md

@@ -14,18 +14,17 @@ branch | status
 
 ## What is Augur?
 
-Relational. Easy to pull data out of for open source software metrics. Collection is verifiably accurate. Augur is a software suite for collecting and measuring structured data
+Augur is a software suite for collecting and measuring structured data
 about [free](https://www.fsf.org/about/) and [open-source](https://opensource.org/docs/osd) software (FOSS) communities.
 
-We gather trace data for a group of repositories, normalize
-it into our data model, and provide a variety of metrics about said
-data. The structure of our data model enables us to synthesize data
-across various platforms to provide meaningful context for meaningful
-questions about the way these communities evolve.
+Augur’s main focus is to measure the overall health and sustainability of open source projects, as these types of projects are system critical for nearly every software organization or company. We do this by gathering data about project repositories and normalizing that into our data model to provide useful metrics about your project’s health. For example, one of our metrics is Burstiness. Burstiness – how are short timeframes of intense activity, followed by a corresponding return to a typical pattern of activity, observed in a project?
+
+This can paint a picture of a project’s focus and gain insight into the potential stability of a project and how its typical cycle of updates occurs. 
 
 We are a [CHAOSS](https://chaoss.community) project, and many of our
-metrics are implementations of the metrics defined by our awesome community. You
-can find more information about [how to get involved on the CHAOSS website](https://chaoss.community/participate/).
+metrics are implementations of the metrics defined by our awesome community. You can find a full list of them [here](https://chaoss.community/metrics/).
+
+For more information on [how to get involved on the CHAOSS website](https://chaoss.community/participate/).
 
 ## Collecting Data
 

docs/source/development-guide/installation.rst

@@ -1,20 +1,20 @@
-Installing for development
+Installing for Development
 =============================
 
-Installing Augur for local development is pretty similar to the normal installation process. This guide will primarily detail the differences between the two instead of regurgitating all the information in the `Getting Started <../getting-started/toc.html>`_ section. If you are completely new to Augur, we recommend following the aforementioned getting started section first; once you feel more comfortable with Augur and how to use it, come back to this document.
+Installing Augur for local development is pretty similar to the normal installation process. This guide will primarily detail the differences between the two instead of regurgitating all the information in the `Getting Started <../getting-started/toc.html>`_ section. If you are completely new to Augur, we recommend following the aforementioned `Getting Started <../getting-started/toc.html>`_ section first; once you feel more comfortable with Augur and how to use it, come back to this document.
 
-Setting up the database
+Setting up the Database
 ------------------------
 
-If they so desired, developers can set up a persistent instance of PostgreSQL on either the local machine or a remote server. The instructions for doing so can be found in the `database <../getting-started/database.html>`_ portion of the Getting Started section
+If they so desire, developers can set up a persistent instance of PostgreSQL on either the local machine or a remote server. The instructions for doing so can be found in the `database <../getting-started/database.html>`_ portion of the Getting Started section
 
 
-However, during development, you might find that you need to reset your database often, especially if you are working on the data collection components of Augur. To this end, we recommend developers make use of our Docker images to quickly provision and terminate database instances in a lightweight and reproducible manner.
+However, during development, you might find that you need to reset your database often, especially if you are working on the data collection components of Augur. To this end, we recommend developers make use of our `Docker images <../docker/docker.html>`_ to quickly provision and terminate database instances in a lightweight and reproducible manner.
 
 
 More information about Augur's Docker images can be found `here <../docker/docker.html>`_. If you're new to our Docker process, we recommend following the `introduction section <../docker/toc.html>`_ first.
 
-Installing from source
+Installing from Source
 ----------------------------
 
 The process for installing Augur's source code for development is essentially the same as detailed in the `Installation <../getting-started/installation.html>`_ section of the Getting Started guide.

docs/source/index.rst

@@ -5,7 +5,7 @@ Welcome!
 ~~~~~~~~
 ~~~~~~~~
 
-Augur's documentation; (pronounced awe-grrr), is split into seven (7) parts. If you’re new to the project, we recommend giving it a once-over as a gentle introduction. Otherwise, feel free to hop right into the docs!
+Augur's documentation; (pronounced awe-grrr), is split into seven (7) parts. If you’re new to the project you can find out more on the software `here <https://github.com/chaoss/augur#readme>`_. We recommend giving it a once-over as a gentle introduction, otherwise, feel free to hop right into the docs!
 
 .. toctree::
    :maxdepth: 2
@@ -28,7 +28,20 @@ Augur's documentation; (pronounced awe-grrr), is split into seven (7) parts. If
   :width: 700
   :alt: Development guide image overview of augur 
 
-If you want to see augur in action, you can view CHAOSS’s augur instance at http://augur.chaoss.io 
+
+What is Augur?
+~~~~~~~~~~~~~~~~
+
+Augur is a software suite for collecting and measuring structured data about free and open-source software (FOSS) communities.
+
+Augur’s main focus is to measure the overall health and sustainability of open source projects, as these types of projects are system critical for nearly every software organization or company. We do this by gathering data about project repositories and normalizing that into our data model to provide useful metrics about your project’s health. For example, one of our metrics is Burstiness. Burstiness – how are short timeframes of intense activity, followed by a corresponding return to a typical pattern of activity, observed in a project? This can paint a picture of a project’s focus and gain insight into the potential stability of a project and how its typical cycle of updates occurs. There are many more useful metrics, and you can find a full list of them `here <https://chaoss.community/metrics/>`_.
+
+
+Augur gathers trace data for a group of repositories, normalize it into our data model, and provide a variety of metrics about that data.
+
+This software is developed as part of the CHAOSS (Community Health Analytics Open Source Software) project. Many of our metrics are implementations of the metrics defined by our community. You can find more information about how to get involved on the `CHAOSS website <https://chaoss.community>`_. 
+
+If you want to see augur in action, you can view CHAOSS’s augur instance `here <http://augur.chaoss.io>`_. 
 
 
 Current maintainers

docs/source/quick-start.rst

@@ -7,7 +7,7 @@ Get going fast! Intended for folks familiar with setting up DevOps environments.
 
 Setting up VirtualBox
 ~~~~~~~~~~~~~~~~~~~~~~~
-- Go to the official box website to download using this link `https://www.virtualbox.org/`
+- Go to the official box website to download using this `link <https://www.virtualbox.org/>`_.
 - Download VirtualBox for "Windows hosts".
 .. image:: development-guide/images/A2.png
   :width: 600