diff --git a/.github/profile/README.md b/.github/profile/README.md new file mode 100644 index 0000000000..fa406baec6 --- /dev/null +++ b/.github/profile/README.md @@ -0,0 +1,8 @@ +# Welcome! +![Augur Landing](chaosscon.jpg) + +Augur is part of the CHAOSS Community, and focuses on the accurate, verifiable collection of open source software health and sustainability data. + +**Through May 18, 2022, Augur will not be issuing new releases. This freeze is due to a highly distributed documentation update effort, and we don't want to have to resolve any more merge conflicts than are necessary** + +Great things are coming! Stay Tuned! diff --git a/.github/profile/augur-landing.jpg b/.github/profile/augur-landing.jpg new file mode 100644 index 0000000000..ac9fbf930e Binary files /dev/null and b/.github/profile/augur-landing.jpg differ diff --git a/.github/profile/chaosscon.jpg b/.github/profile/chaosscon.jpg new file mode 100644 index 0000000000..11538d8033 Binary files /dev/null and b/.github/profile/chaosscon.jpg differ diff --git a/docs/source/deployment/server-deployment.rst b/docs/source/deployment/server-deployment.rst index 1da1b05c00..b1488d3c3f 100644 --- a/docs/source/deployment/server-deployment.rst +++ b/docs/source/deployment/server-deployment.rst @@ -9,7 +9,7 @@ High-Level Steps to Server Installation of Augur 1. Have a list of repositories and groups you want them to be in, following the format in the files `schema/repo_group_load_sample.csv` and `schema/repo_load_sample.csv`. 2. Have access to a server that meets the augur installation pre-requisites (Python, NodeJS, etc). 3. Have nginx installed for front-end service. You can use another HTTP server, but we have instructions for nginx. -4. Make sure you have a database available, owned by a user who has rights to create tables. +4. Make sure you have a database available, owned by a user who has the right to create tables. 5. Have a GitHub API Key handy. Detailed Steps diff --git a/docs/source/development-guide/images/augur-architecture-2.png b/docs/source/development-guide/images/augur-architecture-2.png new file mode 100644 index 0000000000..9a81426d3d Binary files /dev/null and b/docs/source/development-guide/images/augur-architecture-2.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index fd826251bc..35ac819f48 100755 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -20,7 +20,7 @@ Welcome Augur's documentation is split into Seven parts,if you’re new to the p .. schema/toc -.. image:: development-guide/images/augur-architecture.png +.. image:: development-guide/images/augur-architecture-2.png :width: 700 :alt: Development guide image overview of augur diff --git a/docs/source/quick-start.rst b/docs/source/quick-start.rst index 1c8148c843..01a8434353 100644 --- a/docs/source/quick-start.rst +++ b/docs/source/quick-start.rst @@ -58,9 +58,9 @@ Ubuntu download Installing Ubuntu in VirtualBox ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Open the Machine which we created earlier. -- In the pop-up, click the disk image where you have downloaded your Ubuntu and click Finish. -- In the Welcome window select Install Ubuntu and continue with the default options. +- Open the machine which we have created earlier. +- Now in the pop-up, click on the disk image where you have downloaded your Ubuntu and click on finish. +- In the welcome window select Install Ubuntu and move forward with the default options. .. image:: development-guide/images/Af.png :width: 600 - Select Keyboard layout. @@ -118,7 +118,7 @@ Git Configuration git config --global credential.helper cache git config --global credential.helper 'cache --timeout=9999999999999' -- For each platform, perform a command-line login to cache Git credentials for the LINUX user who operates Augur. This step is required to prevent the Facade Commit Counting Diesel from stalling on a command line prompt when repositories move or disappear. +- For each platform, perform a command-line login to cache Git credentials for the LINUX user who operates Augur. This step is required in order to prevent the Facade Commit Counting Diesel from stalling on a command-line prompt when repositories move or disappear. Install Go ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -137,7 +137,7 @@ Python Virtual Environment Configuration .. code-block:: bash - # Ensure you are logged in as your own user on Github and change the "" to your Github username (e.g. "sean") + # Ensure you are logged in as your user on Github and change the "" to your Github username (e.g. "sean") git clone https://github.com//augur.git cd augur/ sudo apt install make @@ -150,7 +150,7 @@ Python Virtual Environment Configuration python -m pip install --upgrade pip make install-dev {Follow prompts. You will need database credentials, a file location for cloned repositories, a GitHub Token, and a GitLab token.} -- Seven sample repositories will load by default. You can delete them if you want to use your own repositories by deleting records from the `repo` table first, then deleting the records from the `repo_groups` table. +- Seven sample repositories will load by default. You can delete them if you want to use your repositories by deleting records from the `repo` table first, then deleting the records from the `repo_groups` table. .. code-block:: bash