Skip to content

Commit

Permalink
Merge pull request #1994 from chaoss/spg-doc-patch-a
Browse files Browse the repository at this point in the history 
schema image update
  • Loading branch information
@sgoggins
sgoggins committed Sep 22, 2022
2 parents f9d5a2e + 23a0d67 commit b2af6d6
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 66 deletions.
90 changes: 45 additions & 45 deletions docs/source/schema/regularly_used_data.rst
View file
Expand Up @@ -7,7 +7,7 @@ List of Regularly Used Data Tables In Augur

* Worker: Facade worker collects, and also stores platform user information in the commits table.

.. image:: commits.png
.. image:: images/commits.png
:width: 200

* Contributor_affiliations: A list of emails and domains, with start and end dates for individuals to have an organizational affiliation.
Expand All @@ -16,15 +16,15 @@ List of Regularly Used Data Tables In Augur
* Can be edited so that an Augur instance can resolve a larger list of affiliations.
* These mappings are summarized in the dm_ tables.

.. image:: contributor_affiliations.png
.. image:: images/contributor_affiliations.png
:width: 200

* Contributor_repo - Storage of a snowball sample of all the repositories anyone in your schema has accessed on GitHub. So, for example, if you wanted to know all the repositories that people on your project contributed to, this would be the table.

* Contributor_breadth_worker populates this table
* Population of this table happens last, and can take a long time.

.. image:: contributor_repo.png
.. image:: images/contributor_repo.png
:width: 200

* Contributors - These are all the contributors to a project/repo. In Augur, all types of contributions create a contributor record. This includes issue comments, pull request comments, label addition, etc. This is different than how GitHub counts contributors; they only include committers.
Expand All @@ -37,7 +37,7 @@ List of Regularly Used Data Tables In Augur
* GitLab Merge Request Worker
* Facade Worker

.. image:: contributors.png
.. image:: images/contributors.png
:width: 200

* Contributors_aliases - These are all the alternate emails that the same contributor might use. These records arise almost entirely from the commit log. For example, if I have two different emails on two different computers that I use when I make a commit, then an alias is created for whatever the 2nd to nth email Augur runs across. If a user’s email cannot be resolved, it is placed in the unresolved_commit_emails table. Coverage is greater than 98% since Augur 1.2.4.
Expand All @@ -46,7 +46,7 @@ List of Regularly Used Data Tables In Augur

* Facade Worker

.. image:: contributors_aliases.png
.. image:: images/contributors_aliases.png
:width: 200

* Discourse_insights - There are nine specific discourse act types identified by the computational linguistic algorithm that underlies the discourse insights worker. This worker analyzes each comment on each issue or pull request sequentially so that context is applied when determining the discourse act type. These types are:
Expand All @@ -65,7 +65,7 @@ List of Regularly Used Data Tables In Augur

* Discourse Insights Worker

.. image:: discourse_insights.png
.. image:: images/discourse_insights.png
:width: 200

* issue_assignees || issue_events || issue_labels
Expand All @@ -74,7 +74,7 @@ List of Regularly Used Data Tables In Augur

* Github or Gitlab Issues Worker

.. image:: issue_assignees.png
.. image:: images/issue_assignees.png
:width: 200

* issue_message_ref - A link between the issue and each message stored in the message table.
Expand All @@ -83,7 +83,7 @@ List of Regularly Used Data Tables In Augur

* Github or Gitlab Issues Worker

.. image:: issue_message_ref.png
.. image:: images/issue_message_ref.png
:width: 200

* issues - Is all the data related to a GitHub Issue.
Expand All @@ -92,12 +92,12 @@ List of Regularly Used Data Tables In Augur

* Github or Gitlab Issues Worker

.. image:: issues.png
.. image:: images/issues.png
:width: 200

* Message - every pull request or issue related message. These are then mapped back to either pull requests, or issues, using the __msg_ref tables

.. image:: message.png
.. image:: images/message.png
:width: 200

* Message_analysis: Two factors evaluated for every pull request on issues message: What is the sentiment of the message (positive or negative), and what is the novelty of the message in the context of other messages in that repository.
Expand All @@ -106,7 +106,7 @@ List of Regularly Used Data Tables In Augur

* Message Insights Worker

.. image:: message_analysis.png
.. image:: images/message_analysis.png
:width: 200

* Message_analysis_summary: A summary level representation of the granular data in message_analysis.
Expand All @@ -115,7 +115,7 @@ List of Regularly Used Data Tables In Augur

* Message Insights Worker

.. image:: message_analysis_summary.png
.. image:: images/message_analysis_summary.png
:width: 200

* Platform: Reference data with two rows: one for GitHub, one for GitLab.
Expand All @@ -124,7 +124,7 @@ List of Regularly Used Data Tables In Augur

* Platform_worker

.. image:: platform.png
.. image:: images/platform.png
:width: 200

* Pull_request_analysis: A representation of the probability of a pull request being merged into a repository, based on analysis of the properties of previously merged pull requests in a repository. (Machine learning worker)
Expand All @@ -133,50 +133,50 @@ List of Regularly Used Data Tables In Augur

* Pull request analysis worker

.. image:: pull_request_analysis.png
.. image:: images/pull_request_analysis.png
:width: 200

* pull_request_assignees || pull_request_commits || pull_request_events || pull_request_files || pull_request_labels || pull_request_message_ref - All the data related to pull requests. Every pull request will be in the pull_requests data.

.. image:: pull_request_assignees.png
.. image:: images/pull_request_assignees.png
:width: 200

.. image:: pull_request_commits.png
.. image:: images/pull_request_commits.png
:width: 200

.. image:: pull_request_events.png
.. image:: images/pull_request_events.png
:width: 200

.. image:: pull_request_files.png
.. image:: images/pull_request_files.png
:width: 200

.. image:: pull_request_labels.png
.. image:: images/pull_request_labels.png
:width: 200

.. image:: pull_request_ref.png
.. image:: images/pull_request_ref.png
:width: 200

* pull_request_meta || pull_request_repo || pull_request_review_message_ref || pull_request_reviewers || pull_request_reviews || pull_request_teams || pull_requests - All the data related to pull requests. Every pull request will be in the pull_requests data.

.. image:: pull_request.png
.. image:: images/pull_request.png
:width: 200

.. image:: pull_request_meta.png
.. image:: images/pull_request_meta.png
:width: 200

.. image:: pull_request_repo.png
.. image:: images/pull_request_repo.png
:width: 200

.. image:: pull_request_review_message_ref.png
.. image:: images/pull_request_review_message_ref.png
:width: 200

.. image:: pull_request_reviewers.png
.. image:: images/pull_request_reviewers.png
:width: 200

.. image:: pull_request_reviews.png
.. image:: images/pull_request_reviews.png
:width: 200

.. image:: pull_request_teams.png
.. image:: images/pull_request_teams.png
:width: 200

* Releases: Github declared software releases or release tags. For example: https://github.com/chaoss/augur/releases
Expand All @@ -185,12 +185,12 @@ List of Regularly Used Data Tables In Augur

* Release Worker.

.. image:: releases.png
.. image:: images/releases.png
:width: 200

* Repo: A list of all the repositories.

.. image:: repo.png
.. image:: images/repo.png
:width: 200

* Repo_badging: A list of CNCF badging information for a project. Reads this api endpoint: https://bestpractices.coreinfrastructure.org/projects.json
Expand All @@ -199,7 +199,7 @@ List of Regularly Used Data Tables In Augur

* linux_badge_worker

.. image:: repo_badging.png
.. image:: images/repo_badging.png
:width: 200

* Repo_cluster_messages: Identifying which messages and repositories are clustered together. Identifies project similarity based on communication patterns.
Expand All @@ -208,7 +208,7 @@ List of Regularly Used Data Tables In Augur

* Clustering Worker

.. image:: repo_cluster_messages.png
.. image:: images/repo_cluster_messages.png
:width: 200

* Repo_dependencies: enumerates every dependency, including dependencies that are not package managed.
Expand All @@ -217,7 +217,7 @@ List of Regularly Used Data Tables In Augur

* deps_worker

.. image:: repo_dependencies.png
.. image:: images/repo_dependencies.png
:width: 200

* Repo_deps_libyear: (enumerates every package managed dependency) Looks up the latest release of any library that is imported into a project. Then it compares that release date, the release version of the library version in your project (and its release date), and calculates how old your version is, compared to the latest version. The resulting statistic is “libyear”. This worker runs at least once a month, so over time, you will see if your libraries are being kept up to date, or not.
Expand All @@ -230,7 +230,7 @@ List of Regularly Used Data Tables In Augur

* deps_libyear_worker

.. image:: repo_deps_libyear.png
.. image:: images/repo_deps_libyear.png
:width: 200

* Repo_deps_scorecard: Runs the OSSF Scorecard over every repository ( https://github.com/ossf/scorecard ) : There are 16 factors that are explained at that repository location.
Expand All @@ -239,12 +239,12 @@ List of Regularly Used Data Tables In Augur

* deps_worker

.. image:: repo_deps_scorecard.png
.. image:: images/repo_deps_scorecard.png
:width: 200

* Repo_groups: reference data. The repo groups in an augur instance.

.. image:: repo_groups.png
.. image:: images/repo_groups.png
:width: 200

* Repo_info: this worker gathers metadata from the platform API that includes things like “number of stars”, “number of forks”, etc. AND it also gives us : Number of issues, number of pull requests, etc. .. THAT information we use to determine if we have collected all of the PRs and Issues associated with a repository.
Expand All @@ -253,7 +253,7 @@ List of Regularly Used Data Tables In Augur

* repo info worker

.. image:: repo_info.png
.. image:: images/repo_info.png
:width: 200

* Repo_insights:
Expand All @@ -262,7 +262,7 @@ List of Regularly Used Data Tables In Augur

* Insight worker

.. image:: repo_insights.png
.. image:: images/repo_insights.png
:width: 200

* Repo_insights_records:
Expand All @@ -271,7 +271,7 @@ List of Regularly Used Data Tables In Augur

* Insight worker

.. image:: repo_insights_records.png
.. image:: images/repo_insights_records.png
:width: 200

* Repo_labor
Expand All @@ -280,22 +280,22 @@ List of Regularly Used Data Tables In Augur

* Value worker

.. image:: repo_labor.png
.. image:: images/repo_labor.png
:width: 200

* Repo_meta: Exists to capture repo data that may be useful in the future. Not currently populated.

.. image:: repo_meta.png
.. image:: images/repo_meta.png
:width: 200

* Repo_sbom_scans: This table links the augur_data schema to the augur_spdx schema to keep a list of repositories that need licenses scanned. (These are for file level license declarations, which are common in Linux Foundation projects, but otherwise not in wide use).

.. image:: repo_sbom_scans.png
.. image:: images/repo_sbom_scans.png
:width: 200

* Repo_stats: Exists to capture repo data that may be useful in the future. Not currently populated.

.. image:: repo_stats.png
.. image:: images/repo_stats.png
:width: 200

* Repo_topic: Identifies probable topics of conversation in discussion threads around issues and pull requests.
Expand All @@ -304,7 +304,7 @@ List of Regularly Used Data Tables In Augur

* Clustering Worker

.. image:: repo_topic.png
.. image:: images/repo_topic.png
:width: 200

* Topic_words: Unigrams, bigrams, and trigrams associated with topics in the repo_topic table.
Expand All @@ -313,7 +313,7 @@ List of Regularly Used Data Tables In Augur

* Clustering Worker

.. image:: topic_words.png
.. image:: images/topic_words.png
:width: 200

* Unresolved_commit_emails - emails from commits that were not initially able to be resolved using automated mechanisms.
Expand All @@ -322,5 +322,5 @@ List of Regularly Used Data Tables In Augur

* Facade Worker.

.. image:: unresolved_commit_emails.png
.. image:: images/unresolved_commit_emails.png
:width: 200

0 comments on commit b2af6d6

Please sign in to comment.