Pin dogpile.cache to ~=0.6.8

[releng/global-jjb.git] / docs / configuration.rst

diff --git a/docs/configuration.rst b/docs/configuration.rst
index 66b4f41..97e9d5b 100644 (file)
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -34,26 +34,28 @@ values used by global-jjb templates.
 **GitHub required parameters**:
 
 :git-url: Set this to the base URL of your GitHub repo. In
-    general this should be <https://github.com>. If you are using
+    general this should be https://github.com. If you are using
     GitHub Enterprise, or some other GitHub-style system, then it
-    should be whatever your installation base URL is.
+    should be whatever your installation base URL is. This sets a job
+    property that GitHub Pull Request Builder requires to work.
+    Note that this is the web url to your project: (eg. https://github.com/$ORG/$PROJECT)
 
 :git-clone-url: This is the clone prefix used by GitHub jobs.
-    Set this to either the same thing as **git-url** or the
-    'git@github.com:' including the trailing ':'
+    Set this to either the same base url as **git-url**, or to
+    'git@github.com:' including the trailing ':'.  Determined
+    by your clone method (https or git).
 
 :github-org: The name of the GitHub organization interpolated
     into the scm config.
 
 :github_pr_org: The name of the GitHub organization. All members
-    of this organization will be able to trigger any job using the
-    `lf-infra-github-pr` macro.
+    of this organization will be able to trigger jobs.
 
 :github_pr_whitelist: List of GitHub members you wish to be able to
-    trigger any job that uses the `lf-infra-github-pr-trigger` macro.
+    trigger jobs.
 
 :github_pr_admin_list: List of GitHub members that will have admin
-    privileges on any job using the `lf-infra-github-pr-trigger` macro.
+    privileges on the jobs.
 
 Example Gerrit Infra: