Skip to content

Commit

Permalink
Merge branch 'main' into Preshh0-patch-5
Browse files Browse the repository at this point in the history
  • Loading branch information
sgoggins authored Jun 23, 2022
2 parents 15a20b7 + 7e88de5 commit 3463f60
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
Welcome to the Augur Documentation!
Augur Documentation
==================================

Welcome Augur's documentation is split into Seven 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!
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!

.. toctree::
:maxdepth: 2
Expand Down Expand Up @@ -29,11 +33,15 @@ 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.
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.

Augur gathers trace data for a group of repositories, normalize it inot our data model, and provide a variety of metrics about the said data.
If you want to see augur in action, you can view CHAOSS’s augur instance at http://augur.chaoss.io

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 awesome community. You can find more information about how to get involved on the CHAOSS website. If you want to see augur in action, you can view some examples of augur instance in the following `sites <https://www.augurlabs.io/live-examples/>`_.

Current maintainers
--------------------
Expand Down

0 comments on commit 3463f60

Please sign in to comment.