Skip to content

Commit 56e2f6d

Browse files
authored
Merge pull request chaoss#3714 from chaoss/docs/scope
add about augur section with our scope statement (lightly edited) Documentation Update only. LGTM. Bypassing rules.
2 parents 4025bba + b593216 commit 56e2f6d

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

docs/source/about-augur/scope.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Scope of the Augur project
2+
==========================
3+
4+
Augur focuses on collecting data from public git-based code hosting platforms ("Forges") such as GitHub and GitLab. This helps us produce data about the health and sustainability of software projects based on the relevant CHAOSS metrics.
5+
The data Augur collects covers more than just code contributions and extends to anything that can be derived from forge data, including comments, change reviews, releases, and other project activity or interactions.
6+
7+
This scope is intentionally narrower than that of the CHAOSS project as a whole to help keep the Augur project sustainable with the resources available.
8+
Usecases and discussion of perspectives outside this defined scope are still welcome in the CHAOSS community, but may not be a good fit for direct contributions to Augur.
9+
These usecases may work best as a complementary add-on project, new working group, or third-party addon to augur that depends on or extends Augur functionality.
10+
Future expansions of Augur's scope may also bring in these community addons into the main codebase if new resources become available to sustain such expansion.

docs/source/about-augur/toc.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
About Augur
2+
===========
3+
This section contains more details about what the Augur project is, including its mission/scope, and what we hope to accomplish.
4+
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
9+
scope

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Augur Documentation
99

1010
getting-started/Welcome
1111
quick-start
12+
about-augur/toc
1213
deployment/toc
1314
getting-started/toc
1415
development-guide/toc

0 commit comments

Comments
 (0)