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

Jump to bottom

Update index.rst #1869

Merged
merged 2 commits into from
Jun 23, 2022
Merged

Update index.rst #1869

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
253938f
Update index.rst
Preshh0 Jun 13, 2022
e1434df
Edit Augur to correct pronounciation.
Preshh0 Jun 14, 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
12 changes: 9 additions & 3 deletions docs/source/index.rst
View file
Open in desktop
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,7 +33,9 @@ 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.

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.

Expand Down