Merge pull request #2031 from chaoss/main

Documentation update from Main
chaoss · Nov 21, 2022 · 2a741de · 2a741de
2 parents 1debab2 + cb5f2d5
commit 2a741de
Show file tree

Hide file tree

Showing 17 changed files with 51 additions and 44 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -24,20 +24,16 @@ $ git remote add upstream https://github.com/chaoss/augur.git
 ```bash
 $ git checkout -b my-new-branch
 ```
-4. Switch between branches
-```bash
-$ git checkout branch-name
-```
 
-5. Make your change(s).
+4. Make your change(s).
 
-6. Commit the change(s) and push to your fork
+5. Commit the change(s) and push to your fork
 ```bash
 $ git add .
 $ git commit -s -m "This is my first commit"
 $ git push -u origin my-new-branch
 ```
-7. Then, [submit a pull request](https://github.com/chaoss/augur/compare).
+6. Then, [submit a pull request](https://github.com/chaoss/augur/compare).
 
 At this point, you're waiting on us. We like to at least comment on pull requests
 within three business days (and, typically, one business day). Once one of our maintainers has had a chance to review your PR, we will either mark it as "needs review" and provide specific feedback on your changes, or we will go ahead and complete the pull request.

diff --git a/README.md b/README.md
@@ -9,6 +9,17 @@
 
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2788/badge)](https://bestpractices.coreinfrastructure.org/projects/2788)
 
+## NEW BETA RELEASE ALERT!
+Augur released a beta of its new version, which is built from the augur-new branch, here: https://github.com/chaoss/augur/releases/tag/v0.42.0
+- The augur-new branch is a stable version of our new architecture, which features:
+  - Dramatic improvement in the speed of large scale (10,000+ repos). All data is obtained for 10k+ repos within a week
+  - A new job management architecture that uses Celery and Redis to manage queues, and enables users to run a Flower job monitoring dashboard
+  - Materialized views to increase the snappiness of API’s and Frontends on large scale data
+  - Changes to primary keys, which now employ a UUID strategy that ensures unique keys across all Augur instances
+  - Support for https://github.com/chaoss/sandiego-rh dashboards (view a sample here: https://eightknot.osci.io/). (beautification coming soon!)
+  - Data collection completeness assurance enabled by a structured, relational data set that is easily compared with platform API Endpoints
+- The next release of the new version will include a hosted version of Augur where anyone can create an account and add repos “they care about”. If the hosted instance already has a requested organization or repository it will be added to a user’s view. If its a new repository or organization, the user will be notified that collection will take (time required for the scale of repositories added). (edited) 
+
 ## What is Augur?
 
 Augur is a software suite for collecting and measuring structured data

diff --git a/docs/source/development-guide/images/Aa.jpeg b/docs/source/development-guide/images/Aa.jpeg
diff --git a/docs/source/development-guide/images/Aa.png b/docs/source/development-guide/images/Aa.png
diff --git a/docs/source/development-guide/images/Ab.jpeg b/docs/source/development-guide/images/Ab.jpeg
diff --git a/docs/source/development-guide/images/Ab.png b/docs/source/development-guide/images/Ab.png
diff --git a/docs/source/development-guide/images/Ac.jpeg b/docs/source/development-guide/images/Ac.jpeg
diff --git a/docs/source/development-guide/images/Ac.png b/docs/source/development-guide/images/Ac.png
diff --git a/docs/source/development-guide/images/Ad.jpeg b/docs/source/development-guide/images/Ad.jpeg
diff --git a/docs/source/development-guide/images/Ad.png b/docs/source/development-guide/images/Ad.png
diff --git a/docs/source/development-guide/images/Ae .png b/docs/source/development-guide/images/Ae .png
diff --git a/docs/source/development-guide/images/Ae.jpeg b/docs/source/development-guide/images/Ae.jpeg
diff --git a/docs/source/development-guide/images/Af.jpeg b/docs/source/development-guide/images/Af.jpeg
diff --git a/docs/source/development-guide/images/Af.png b/docs/source/development-guide/images/Af.png
diff --git a/docs/source/getting-started/Welcome.rst b/docs/source/getting-started/Welcome.rst
@@ -27,7 +27,7 @@ Example: Hi, my name is Precious Onyewuchi. I’m an outreachy intern contributi
 This is a picture of my own introduction. Some parts of the image were blurred for privacy reasons
 
 3)      As a follow-up for number two (2), if you’re contributing from a program (e.g Outreachy, or GSOC), find the respective channel for your program and join it. It’d be easier to get questions regarding that program answered and you can see other people like you in the same program to interact with and get help from. The channel for GSOC is #gsoc, and the channel for Outreachy is #outreachy, #general is for general questions and #augur is for stuff designated to augur, (e.g Installation (i figured that last part a little later. So, you’re welcome!)
-    .. image:: images/channels.png
+    .. image:: images/channels.PNG
     :width: 400
     :alt: "Slack image"
 

diff --git a/docs/source/getting-started/images/chaoss_slack_workspace.png b/docs/source/getting-started/images/chaoss_slack_workspace.png
diff --git a/docs/source/schema/regularly_used_data.rst b/docs/source/schema/regularly_used_data.rst