Merge pull request #2432 from Seltyk/seltyk-install

[docs] Clarify prompts during `make install`
chaoss · Jun 5, 2023 · 037d00e · 037d00e
2 parents 05db18c + 170570d
commit 037d00e
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 9 deletions.
diff --git a/docs/new-install.md b/docs/new-install.md
@@ -250,9 +250,17 @@ Create a Python Virtual Environment `python3 -m venv ~/virtual-env-directory`
 
 Activate your Python Virtual Environment `source ~/virtual-env-directory/bin/activate`
 
-From the root of the Augur Directory, type `make install`
-
-You will be prompted to provide your GitHub username and password, your GitLab username and password, and the postgresql database where you want to have the Augur Schema built. You will also be prompted to provide a directory where repositories will be clone into. 
+From the root of the Augur Directory, type `make install`. You will be prompted to provide:
+
+- "User" is the PSQL database user, which is `augur` if you followed instructions exactly
+- "Password" is the above user's password
+- "Host" is the domain used with nginx, e.g. `ai.chaoss.io`
+- "Port" is 5432 unless you reconfigured something
+- "Database" is the name of the Augur database, which is `augur` if you followed instructions exactly
+- The GitHub token created earlier
+- Then the username associated with it
+- Then the same for GitLab
+- and finally a directory to clone repositories to
 
 ## Post Installation of Augur
 

diff --git a/docs/new-install.rst b/docs/new-install.rst
@@ -317,12 +317,20 @@ Create a Python Virtual Environment
 Activate your Python Virtual Environment
 ``source ~/virtual-env-directory/bin/activate``
 
-From the root of the Augur Directory, type ``make install``
-
-You will be prompted to provide your GitHub username and password, your
-GitLab username and password, and the postgresql database where you want
-to have the Augur Schema built. You will also be prompted to provide a
-directory where repositories will be clone into.
+From the root of the Augur Directory, type ``make install``. You will be
+prompted to provide:
+
+- "User" is the PSQL database user, which is ``augur`` if you followed
+  instructions exactly
+- "Password" is the above user's password
+- "Host" is the domain used with nginx, e.g. ``ai.chaoss.io``
+- "Port" is 5432 unless you reconfigured something
+- "Database" is the name of the Augur database, which is ``augur`` if you
+  followed instructions exactly
+- The GitHub token created earlier
+- Then the username associated with it
+- Then the same for GitLab
+- and finally a directory to clone repositories to
 
 Post Installation of Augur
 --------------------------