Skip to content

Commit c97a48b

Browse files
maskboyAvioraNod
andauthored
Fix: #14510 Add alt-text codeblock to Images for Userguide: jobs.rst (#14530)
Signed-off-by: maskboyAvi <[email protected]> Co-authored-by: Don Naro <[email protected]>
1 parent 259bca0 commit c97a48b

File tree

1 file changed

+27
-13
lines changed

1 file changed

+27
-13
lines changed

docs/docsite/rst/userguide/jobs.rst

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ The default view is collapsed (**Compact**) with the job name, status, job type,
1414
|Jobs - home with example job|
1515

1616
.. |Jobs - home with example job| image:: ../common/images/jobs-home-with-example-job.png
17-
17+
:alt: Jobs List with Example Jobs
1818
.. image:: ../common/images/jobs-list-all-expanded.png
19+
:alt: Expanded Jobs List
1920

20-
Actions you can take from this screen include viewing the details and standard output of a particular job, relaunching (|launch|) jobs, or removing selected jobs. The relaunch operation only applies to relaunches of playbook runs and does not apply to project/inventory updates, system jobs, workflow jobs, etc.
21+
Actions you can take from this screen include viewing the details and standard output of a particular job, relaunching (|launch|) jobs, or removing selected jobs.The relaunch operation only applies to relaunches of playbook runs and does not apply to project/inventory updates, system jobs, workflow jobs, etc.
2122

2223
.. _ug_job_results:
2324

@@ -29,12 +30,13 @@ When a job relaunches, you are directed the Jobs Output screen as the job runs.
2930

3031

3132
.. image:: ../common/images/job-details-view-filters.png
32-
33+
:alt: Filter options in the Jobs Output window
3334

3435
- The **Stdout** option is the default display that shows the job processes and output
3536
- The **Event** option allows you to filter by the event(s) of interest, such as errors, host failures, host retries, items skipped, etc. You can include as many events in the filter as necessary.
3637

3738
.. image:: ../common/images/job-details-view-filters-examples.png
39+
:alt: Selected filter examples from the Jobs Output window
3840

3941
- The **Advanced** option is a refined search that allows you a combination of including or excluding criteria, searching by key, or by lookup type. For details about using Search, refer to the :ref:`ug_search` chapter.
4042

@@ -55,14 +57,19 @@ When an inventory sync is executed, the full results automatically display in th
5557
The icons at the top right corner of the Output tab allow you to relaunch (|launch|), download (|download|) the job output, or delete (|delete|) the job.
5658

5759
.. |launch| image:: ../common/images/launch-button.png
60+
:alt: Launch Action Button
5861
.. |delete| image:: ../common/images/delete-button.png
62+
:alt: Delete Action Button
5963
.. |cancel| image:: ../common/images/job-cancel-button.png
64+
:alt: Cancel Action Button
6065
.. |download| image:: ../common/images/download.png
66+
:alt: Download Action Button
6167

6268

6369
|job details example of inventory sync|
6470

6571
.. |job details example of inventory sync| image:: ../common/images/jobs-show-job-results-for-inv-sync.png
72+
:alt: Example output for a successful Inventory Sync job
6673

6774

6875
.. note:: An inventory update can be performed while a related job is running. In cases where you have a big project (around 10 GB), disk space on ``/tmp`` may be an issue.
@@ -71,11 +78,12 @@ The icons at the top right corner of the Output tab allow you to relaunch (|laun
7178
Inventory sync details
7279
~~~~~~~~~~~~~~~~~~~~~~~
7380

74-
Access the **Details** tab to provide details about the job execution.
81+
Access the **Details** tab to provide details about the job execution.
7582

7683
.. image:: ../common/images/jobs-show-job-details-for-inv-sync.png
84+
:alt: Example details for an Inventory Sync job
7785

78-
Notable details of the job executed are:
86+
Notable details of the job executed are:
7987

8088
- **Status**: Can be any of the following:
8189

@@ -109,15 +117,17 @@ SCM Inventory Jobs
109117
When an inventory sourced from an SCM is executed, the full results automatically display in the Output tab. This shows the same information you would see if you ran it through the Ansible command line, and can be useful for debugging. The icons at the top right corner of the Output tab allow you to relaunch (|launch|), download (|download|) the job output, or delete (|delete|) the job.
110118

111119
.. image:: ../common/images/jobs-show-job-results-for-scm-job.png
120+
:alt: Example output for a successful SCM job
112121

113122
SCM inventory details
114123
~~~~~~~~~~~~~~~~~~~~~~
115124

116-
Access the **Details** tab to provide details about the job execution and its associated project.
125+
Access the **Details** tab to provide details about the job execution and its associated project.
117126

118127
.. image:: ../common/images/jobs-show-job-details-for-scm-job.png
128+
:alt: Example details for an SCM job
119129

120-
Notable details of the job executed are:
130+
Notable details of the job executed are:
121131

122132
- **Status**: Can be any of the following:
123133

@@ -157,6 +167,7 @@ Playbook Run Jobs
157167
When a playbook is executed, the full results automatically display in the Output tab. This shows the same information you would see if you ran it through the Ansible command line, and can be useful for debugging.
158168

159169
.. image:: ../common/images/jobs-show-job-results-for-example-job.png
170+
:alt: Example output for a successful playbook run
160171

161172
The events summary captures a tally of events that were run as part of this playbook:
162173

@@ -169,7 +180,7 @@ The events summary captures a tally of events that were run as part of this play
169180
- the amount of time it took to complete the playbook run in the **Elapsed** field
170181

171182
.. image:: ../common/images/jobs-events-summary.png
172-
183+
:alt: Example summary details for a playbook
173184

174185
The icons next to the events summary allow you to relaunch (|launch|), download (|download|) the job output, or delete (|delete|) the job.
175186

@@ -178,7 +189,7 @@ The host status bar runs across the top of the Output view. Hover over a section
178189
|Job - All Host Events|
179190

180191
.. |Job - All Host Events| image:: ../common/images/job-all-host-events.png
181-
192+
:alt: Show All Host Events
182193

183194
The output for a Playbook job is also accessible after launching a job from the **Jobs** tab of its Job Templates page.
184195

@@ -200,24 +211,27 @@ Use Search to look up specific events, hostnames, and their statuses. To filter
200211
These statuses also display at bottom of each Stdout pane, in a group of "stats" called the Host Summary fields.
201212

202213
.. image:: ../common/images/job-std-out-host-summary-rescued-ignored.png
203-
214+
:alt: Example summary details in standard output
204215

205216
The example below shows a search with only unreachable hosts.
206217

207218
.. image:: ../common/images/job-std-out-filter-failed.png
219+
:alt: Example of errored jobs filtered by unreachable hosts
208220

209221
For more details about using the Search, refer to the :ref:`ug_search` chapter.
210222

211223
The standard output view displays all the events that occur on a particular job. By default, all rows are expanded so that all the details are displayed. Use the collapse-all button (|collapse-all|) to switch to a view that only contains the headers for plays and tasks. Click the (|expand-all|) button to view all lines of the standard output.
212224

213225
.. |collapse-all| image:: ../common/images/job-details-view-std-out-collapse-all-icon.png
226+
:alt: Collapse All Icon
214227
.. |expand-all| image:: ../common/images/job-details-view-std-out-expand-all-icon.png
228+
:alt: Expand All Icon
215229

216230
Alternatively, you can display all the details of a specific play or task by clicking on the arrow icons next to them. Click an arrow from sideways to downward to expand the lines associated with that play or task. Click the arrow back to the sideways position to collapse and hide the lines.
217231

218232

219233
.. image:: ../common/images/job-details-view-std-out-expand-collapse-icons.png
220-
234+
:alt: Expand and Collapse Icons
221235

222236
Things to note when viewing details in the expand/collapse mode:
223237

@@ -250,7 +264,7 @@ The **Host Details** dialog shows information about the host affected by the sel
250264
- if applicable, the Ansible **Module** for the task, and any *arguments* for that module
251265

252266
.. image:: ../common/images/job-details-host-hostevent.png
253-
267+
:alt: Host Events Details
254268

255269
To view the results in JSON format, click on the **JSON** tab. To view the output of the task, click the **Standard Out**. To view errors from the output, click **Standard Error**.
256270

@@ -262,7 +276,7 @@ Playbook run details
262276
Access the **Details** tab to provide details about the job execution.
263277

264278
.. image:: ../common/images/jobs-show-job-details-for-example-job.png
265-
279+
:alt: Example Job details for a playbook run
266280

267281
Notable details of the job executed are:
268282

0 commit comments

Comments
 (0)