Skip to content

Commit 1d1b97a

Browse files
authored
Merge pull request #3644 from nancywrites/docs-update
[docs] beginner-friendly rewrite of "What is Augur?" section
2 parents b16fb09 + 919a4f6 commit 1d1b97a

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

docs/source/index.rst

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,38 @@ Augur Documentation
3131

3232
What is Augur?
3333
~~~~~~~~~~~~~~~~
34+
Augur is a software tool that helps you collect and measure information about `open source <https://opensource.com/resources/what-open-source>`_ software projects. Augur focuses on collecting data from public git-based code hosting platforms ("Forges") such as GitHub and GitLab to produce data about the health and sustainability of software projects based on the relevant CHAOSS metrics.
3435

35-
Augur is a software suite for collecting and measuring structured data about free and open-source software (FOSS) communities.
36+
The main goal of Augur is to understand how healthy and sustainable a project is. Healthy projects are easier to rely on, and they are important because many software organizations or companies depend on open-source software.
3637

37-
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/>`__.
38+
How Augur works
39+
---------------
3840

41+
1. Augur looks at the project’s repositories (the place where the project’s code and files live).
42+
2. It collects data about activity that is happening in the project, including issues, comments, code changes, etc.
43+
3. It organizes this data into a standard format called a data model.
44+
4. Then it calculates metrics that tell you about the project’s health.
3945

40-
Augur gathers trace data for a group of repositories, normalize it into our data model, and provide a variety of metrics about that data.
46+
Example of a metric: Burstiness
47+
-------------------------------
48+
- Burstiness is one of Augur’s metrics.
49+
- It shows periods when a project has a lot of activity in a short time, followed by periods when activity goes back to normal.
50+
- This helps you see a project’s focus, update patterns, and stability.
51+
- In other words, you can tell how often big changes happen and whether the project works in a steady, predictable way.
4152

42-
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>`_.
53+
Augur calculates many other metrics, which you can see in the `full list <https://chaoss.community/metrics/>`_.
4354

44-
If you want to see augur in action, you can view CHAOSS's augur instance `here <http://augur.chaoss.io>`_.
55+
Who develops Augur
56+
--------------------
57+
58+
- Augur is developed as part of CHAOSS (Community Health Analytics in Open Source Software).
59+
- Many of Augur’s metrics come directly from the CHAOSS community.
60+
- If you want to get involved, visit the `CHAOSS website <https://chaoss.community>`_.
61+
62+
See it in action
63+
-------------------
64+
65+
- You can check out Augur live on the `CHAOSS instance <https://ai.chaoss.io>`_.
4566

4667

4768
Current maintainers

0 commit comments

Comments
 (0)