summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichelle McCausland <141345897+michellemacrh@users.noreply.github.com>2023-10-05 18:40:07 +0200
committerGitHub <noreply@github.com>2023-10-05 18:40:07 +0200
commit4008d72af6b8e0f8e2119f3b1abfd1724a65c41e (patch)
tree91b4ccb9c006426078c21d09a803ec7d5ff61e93
parentFix collection test flake due to successful canceled command (#14519) (diff)
downloadawx-4008d72af6b8e0f8e2119f3b1abfd1724a65c41e.tar.xz
awx-4008d72af6b8e0f8e2119f3b1abfd1724a65c41e.zip
issue-14522: Add alt-text codeblock to Images for Userguide: webhooks.rst (#14529)
Signed-off-by: Michelle McCausland <mmccausl@redhat.com>
-rw-r--r--docs/docsite/rst/userguide/webhooks.rst23
1 files changed, 20 insertions, 3 deletions
diff --git a/docs/docsite/rst/userguide/webhooks.rst b/docs/docsite/rst/userguide/webhooks.rst
index f2cde51dbf..72f1e90649 100644
--- a/docs/docsite/rst/userguide/webhooks.rst
+++ b/docs/docsite/rst/userguide/webhooks.rst
@@ -39,6 +39,7 @@ AWX has the ability to run jobs based on a triggered webhook event coming in. Jo
g. In the Scope fields, the automation webhook only needs repo scope access, with the exception of invites. For information about other scopes, click the link right above the table to access the docs.
.. image:: ../common/images/webhooks-create-webhook-github-scope.png
+ :alt: Link to more information on scopes
h. Click the **Generate Token** button.
@@ -50,26 +51,31 @@ AWX has the ability to run jobs based on a triggered webhook event coming in. Jo
b. Make note of the name of this credential, as it will be used in the job template that posts back to GitHub.
.. image:: ../common/images/webhooks-create-credential-github-PAT-token.png
+ :alt: Enter your generated PAT into the Token field
c. Go to the job template with which you want to enable webhooks, and select the webhook service and credential you created in the previous step.
.. image:: ../common/images/webhooks-job-template-gh-webhook-credential.png
+ :alt: Select the webhook service and credential you created
|
d. Click **Save**. Now your job template is set up to be able to post back to GitHub. An example of one may look like this:
.. image:: ../common/images/webhooks-awx-to-github-status.png
+ :alt: An example GitHub status that shows all checks have passed
.. _ug_webhooks_setup_github:
3. Go to a specific GitHub repo you want to configure webhooks and click **Settings**.
.. image:: ../common/images/webhooks-github-repo-settings.png
+ :alt: Settings link in your GitHub repo
4. Under Options, click **Webhooks**.
.. image:: ../common/images/webhooks-github-repo-settings-options.png
+ :alt: Webhooks link under Options
5. On the Webhooks page, click **Add webhook**.
@@ -80,22 +86,24 @@ AWX has the ability to run jobs based on a triggered webhook event coming in. Jo
c. Copy the contents of the **Webhook Key** from the job template above and paste it in the **Secret** field.
d. Leave **Enable SSL verification** selected.
- .. image:: ../common/images/webhooks-github-repo-add-webhook.png
-
- |
+ .. image:: ../common/images/webhooks-github-repo-add-webhook.png
+ :alt: Add Webhook page
e. Next, you must select the types of events you want to trigger a webhook. Any such event will trigger the Job or Workflow. In order to have job status (pending, error, success) sent back to GitHub, you must select **Pull requests** in the individual events section.
.. image:: ../common/images/webhooks-github-repo-choose-events.png
+ :alt: List of trigger events for the webhook
f. Leave **Active** checked and click **Add Webhook**.
.. image:: ../common/images/webhooks-github-repo-add-webhook-actve.png
+ :alt: Active option and Add Webhook button
7. After your webhook is configured, it displays in the list of webhooks active for your repo, along with the ability to edit or delete it. Click on a webhook, and it brings you to the Manage webhook screen. Scroll to the very bottom of the screen to view all the delivery attempts made to your webhook and whether they succeeded or failed.
.. image:: ../common/images/webhooks-github-repo-webhooks-deliveries.png
+ :alt: An example listing of recent deliveries
For more information, refer to the `GitHub Webhooks developer documentation <https://developer.github.com/webhooks/>`_.
@@ -113,12 +121,14 @@ AWX has the ability to run jobs based on a triggered webhook event coming in. Jo
b. On the sidebar, under User Settings, click **Access Tokens**.
.. image:: ../common/images/webhooks-create-webhook-gitlab-settings.png
+ :alt: Access Tokens link under User Settings
c. In the **Name** field, enter a brief description about what this PAT will be used for.
d. Skip the **Expires at** field unless you want to set an expiration date for your webhook.
e. In the Scopes fields, select the ones applicable to your integration. For AWX, API is the only selection necessary.
.. image:: ../common/images/webhooks-create-webhook-gitlab-scope.png
+ :alt: Personal Access Token page
f. Click the **Create personal access token** button.
@@ -130,16 +140,19 @@ AWX has the ability to run jobs based on a triggered webhook event coming in. Jo
b. Make note of the name of this credential, as it will be used in the job template that posts back to GitHub.
.. image:: ../common/images/webhooks-create-credential-gitlab-PAT-token.png
+ :alt: Create New Credential page
c. Go to the job template with which you want to enable webhooks, and select the webhook service and credential you created in the previous step.
.. image:: ../common/images/webhooks-job-template-gl-webhook-credential.png
+ :alt: Select the webhook credential you created
|
d. Click **Save**. Now your job template is set up to be able to post back to GitLab. An example of one may look like this:
.. image:: ../common/images/webhooks-awx-to-gitlab-status.png
+ :alt: An example GitLab status message
.. _ug_webhooks_setup_gitlab:
@@ -147,6 +160,7 @@ AWX has the ability to run jobs based on a triggered webhook event coming in. Jo
3. Go to a specific GitLab repo you want to configure webhooks and click **Settings > Integrations**.
.. image:: ../common/images/webhooks-gitlab-repo-settings.png
+ :alt: Integrations link under Settings
4. To complete the Integrations page, you need to :ref:`enable webhooks in a job template <ug_jt_enable_webhooks>` (or in a :ref:`workflow job template <ug_wfjt_enable_webhooks>`), which will provide you with the following information:
@@ -157,6 +171,7 @@ AWX has the ability to run jobs based on a triggered webhook event coming in. Jo
e. Click **Add webhook**.
.. image:: ../common/images/webhooks-gitlab-repo-add-webhook.png
+ :alt: Integrations page
5. After your webhook is configured, it displays in the list of Project Webhooks for your repo, along with the ability to test events, edit or delete the webhook. Testing a webhook event displays the results at the top of the page whether it succeeded or failed.
@@ -170,5 +185,7 @@ Payload output
The entire payload is exposed as an extra variable. To view the payload information, go to the Jobs Detail view of the job template that ran with the webhook enabled. In the **Extra Variables** field of the Details pane, view the payload output from the ``awx_webhook_payload`` variable, as shown in the example below.
.. image:: ../common/images/webhooks-jobs-extra-vars-payload.png
+ :alt: Details page with payload output
.. image:: ../common/images/webhooks-jobs-extra-vars-payload-expanded.png
+ :alt: Variables field expanded view