Skip to content

Commit aa1be85

Browse files
authored
Editing controller files for DITA (ansible#3811) (ansible#3812)
Using automation execution UI and modular compliance chapter 27 https://issues.redhat.com/browse/AAP-45161 Affects `titles/controller-user-guide`
1 parent 6f62c13 commit aa1be85

File tree

4 files changed

+16
-6
lines changed

4 files changed

+16
-6
lines changed

downstream/assemblies/platform/assembly-ug-controller-work-with-webhooks.adoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
13
[id="controller-work-with-webhooks"]
24

35
= Working with Webhooks
46

5-
A Webhook enables you to execute specified commands between applications over the web.
7+
Use webhooks to run specified commands between applications over the web.
68
{ControllerNameStart} currently provides webhook integration with GitHub and GitLab.
79

8-
Set up a webhook using the following services:
10+
Set up a webhook by using the following services:
911

1012
* xref:controller-set-up-github-webhook[Setting up a GitHub webhook]
1113
* xref:controller-set-up-gitlab-webhook[Setting up a GitLab webhook]
@@ -17,5 +19,7 @@ Receiving another kind of event results in messages such as the following in the
1719
`awx.main.models.mixins Webhook event did not have a status API endpoint associated, skipping.`
1820

1921
include::platform/proc-controller-set-up-github-webhook.adoc[leveloffset=+1]
22+
2023
include::platform/proc-controller-set-up-gitlab-webhook.adoc[leveloffset=+1]
24+
2125
include::platform/proc-controller-view-payload-output.adoc[leveloffset=+1]

downstream/modules/platform/proc-controller-set-up-github-webhook.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
13
[id="controller-set-up-github-webhook"]
24

35
= Setting up a GitHub webhook
@@ -12,7 +14,7 @@ If you do not need {ControllerName} to post job statuses back to the webhook ser
1214
.. In the profile settings of your GitHub account, select *Settings*.
1315
.. From the navigation panel, select menu:<> Developer Settings[].
1416
.. On the *Developer Settings* page, select *Personal access tokens*.
15-
.. Select *Tokens(classic)*
17+
.. Select *Tokens (classic)*
1618
.. From the *Personal access tokens* screen, click btn:[Generate a personal access token].
1719
.. When prompted, enter your GitHub account password to continue.
1820
.. In the *Note* field, enter a brief description about what this PAT is used for.
@@ -60,4 +62,4 @@ Click a webhook, to go to the *Manage webhook* screen.
6062
. Scroll to view the delivery attempts made to your webhook and whether they succeeded or failed.
6163

6264
.Additional resources
63-
For more information, see the link:https://docs.github.com/en/webhooks[Webhooks documentation].
65+
* link:https://docs.github.com/en/webhooks[Webhooks documentation]

downstream/modules/platform/proc-controller-set-up-gitlab-webhook.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
13
[id="controller-set-up-gitlab-webhook"]
24

35
= Setting up a GitLab webhook
@@ -51,4 +53,4 @@ To have job status (pending, error, success) sent back to GitLab, you must selec
5153
Testing a webhook event displays the results on each page whether it succeeded or failed.
5254

5355
.Additional resources
54-
For more information, see link:https://docs.gitlab.com/ee/user/project/integrations/webhooks.html[Webhooks].
56+
* link:https://docs.gitlab.com/ee/user/project/integrations/webhooks.html[Webhooks]

downstream/modules/platform/proc-controller-view-payload-output.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
13
[id="controller-view-payload-output"]
24

35
= Viewing the payload output
@@ -10,6 +12,6 @@ You can view the entire payload exposed as an extra variable.
1012
. Select the job template with the webhook enabled.
1113
. Select the *Details* tab.
1214
. In the *Extra Variables* field, view the payload output from the `awx_webhook_payload` variable, as shown in the following example:
13-
15+
+
1416
image::ug-webhooks-jobs-extra-vars-payload.png[Webhooks extra variables payload]
1517
image::ug-webhooks-jobs-extra-vars-payload-expanded.png[Webhook extra variables payload expanded]

0 commit comments

Comments
 (0)