doc: clarify sshkey option usage in github connection

The `sshkey` option is only there for usage when using the webhook
method of configuring the GitHub connection, this change documents
and clarifies that.

Change-Id: Iee5cccc12b5226aec8aadfe3bd73e8e52f98aac2
This commit is contained in:
Mohammed Naser 2019-02-07 15:46:39 -05:00 committed by Paul Belanger
parent 2a36eea341
commit f051af6c8c
1 changed files with 2 additions and 1 deletions

View File

@ -138,7 +138,8 @@ The supported options in ``zuul.conf`` connections are:
.. attr:: sshkey
:default: ~/.ssh/id_rsa
Path to SSH key to use when cloning github repositories.
Path to SSH key to use when cloning github repositories if Zuul
is configured with Webhooks.
.. attr:: server
:default: github.com