diff options
author | Zuul <zuul@review.openstack.org> | 2017-12-12 08:15:19 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2017-12-12 08:15:19 +0000 |
commit | 83f504c966c0b83a2ae1e174975d7ba5bd7a705e (patch) | |
tree | ceec0c6aaacb23b9b22f9e31ad0771779c0fbf72 /doc | |
parent | 51cbbe8fc3c3a8ac47d4e93f33e10d10c7ab19f2 (diff) | |
parent | abac0d0cd8287cf9c39c426b5d4106422a97ac34 (diff) | |
download | zuul-83f504c966c0b83a2ae1e174975d7ba5bd7a705e.tar.gz |
Merge "Fix line wrapping in github docs" into feature/zuulv3
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/admin/drivers/github.rst | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/source/admin/drivers/github.rst b/doc/source/admin/drivers/github.rst index 8dd776414..4f46af694 100644 --- a/doc/source/admin/drivers/github.rst +++ b/doc/source/admin/drivers/github.rst @@ -18,9 +18,11 @@ the project's owner needs to know the zuul endpoint and the webhook secrets. Web-Hook ........ -To configure a project's `webhook events <https://developer.github.com/webhooks/creating/>`_: +To configure a project's `webhook events +<https://developer.github.com/webhooks/creating/>`_: -* Set *Payload URL* to ``http://<zuul-hostname>/connection/<connection-name>/payload``. +* Set *Payload URL* to + ``http://<zuul-hostname>/connection/<connection-name>/payload``. * Set *Content Type* to ``application/json``. @@ -30,22 +32,27 @@ You will also need to have a GitHub user created for your zuul: * Zuul public key needs to be added to the GitHub account -* A api_token needs to be created too, see this `article <See https://help.github.com/articles/creating-an-access-token-for-command-line-use/>`_ +* A api_token needs to be created too, see this `article + <https://help.github.com/articles/creating-an-access-token-for-command-line-use/>`_ Then in the zuul.conf, set webhook_token and api_token. Application ........... -To create a `GitHub application <https://developer.github.com/apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps/>`_: +To create a `GitHub application +<https://developer.github.com/apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps/>`_: -* Go to your organization settings page to create the application, e.g.: https://github.com/organizations/my-org/settings/apps/new +* Go to your organization settings page to create the application, e.g.: + https://github.com/organizations/my-org/settings/apps/new * Set GitHub App name to "my-org-zuul" -* Set Setup URL to your setup documentation, when user install the application they are redirected to this url +* Set Setup URL to your setup documentation, when user install the application + they are redirected to this url -* Set Webhook URL to ``http://<zuul-hostname>/connection/<connection-name>/payload``. +* Set Webhook URL to + ``http://<zuul-hostname>/connection/<connection-name>/payload``. * Create a Webhook secret @@ -93,7 +100,8 @@ Then in the zuul.conf, set webhook_token, app_id and app_key. After restarting zuul-scheduler, verify in the 'Advanced' tab that the Ping payload works (green tick and 200 response) -Users can now install the application using its public page, e.g.: https://github.com/apps/my-org-zuul +Users can now install the application using its public page, e.g.: +https://github.com/apps/my-org-zuul Connection Configuration |