From 253938f525b58635e6d63100b730383dc2a735aa Mon Sep 17 00:00:00 2001 From: Preshh0 <42142405+Preshh0@users.noreply.github.com> Date: Mon, 13 Jun 2022 20:39:39 +0100 Subject: [PATCH 1/4] Update index.rst In this PR, I: - Made a few edits to make the document more readable. - Added the pronunciation for Augur. --- docs/source/index.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 35ac819f48..021b1a35a9 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -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 aww-gur), 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 @@ -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. From e1434df13b754b55c1dafd35c689ead490618cb9 Mon Sep 17 00:00:00 2001 From: Preshh0 <42142405+Preshh0@users.noreply.github.com> Date: Tue, 14 Jun 2022 16:26:43 +0100 Subject: [PATCH 2/4] Edit Augur to correct pronounciation. --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 021b1a35a9..368043f44b 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,7 +5,7 @@ Welcome! ~~~~~~~~ ~~~~~~~~ -Augur's documentation; (pronounced aww-gur), 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, we recommend giving it a once-over as a gentle introduction. Otherwise, feel free to hop right into the docs! .. toctree:: :maxdepth: 2 From c2bc67ce2ac23da001366ce7c8bbfdfe199264bf Mon Sep 17 00:00:00 2001 From: Preshh0 <42142405+Preshh0@users.noreply.github.com> Date: Sun, 19 Jun 2022 15:06:53 +0100 Subject: [PATCH 3/4] Updated the missing link. In this PR, I: - Added the missing link that was raised in Issue #1612 Signed-off-by: Precious Onyewuchi --- docs/source/index.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 35ac819f48..5512ac77ac 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -29,11 +29,13 @@ 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. +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 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 CHAOSS’s augur instance. +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. + +If you want to see augur in action, you can view CHAOSS’s augur instance. Current maintainers -------------------- From 5367dcdd06636c9d236705eb4b57238ed7c62110 Mon Sep 17 00:00:00 2001 From: Preshh0 <42142405+Preshh0@users.noreply.github.com> Date: Mon, 20 Jun 2022 18:00:04 +0100 Subject: [PATCH 4/4] Update index.rst In this PR, I: - Linked to the CHAOSS website in the appropriate places so users can easily reference them. --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 35ac819f48..a8f3a3ee85 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -33,7 +33,7 @@ Augur’s main focus is to measure the overall health and sustainability of open 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. -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 CHAOSS’s augur instance. +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 CHAOSS’s augur instance. Current maintainers --------------------