From 5ec44892d6a633d3246aa8edca13faff958fb704 Mon Sep 17 00:00:00 2001 From: EMcWhinn <122449381+EMcWhinn@users.noreply.github.com> Date: Wed, 21 May 2025 15:16:24 +0100 Subject: [PATCH] Modularizing chapter 8 of controller user guide (#3515) * Modularizing chapter 8 of controller user guide Using automation execution UI and modular compliance chapter 8 https://issues.redhat.com/browse/AAP-45084 Affects titles/controller-user-guide * Modular compliance chapter 8 * Peer review edits --- ...-ug-controller-workflow-job-templates.adoc | 25 +++++++++++++++++-- .../con-controller-work-with-permissions.adoc | 2 ++ ...con-controller-workflow-notifications.adoc | 2 +- .../proc-controller-build-workflow.adoc | 2 +- ...controller-copy-workflow-job-template.adoc | 4 +-- ...c-controller-create-workflow-template.adoc | 4 +++ 6 files changed, 33 insertions(+), 6 deletions(-) diff --git a/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc b/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc index 069b3a8472..b382facea8 100644 --- a/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc +++ b/downstream/assemblies/platform/assembly-ug-controller-workflow-job-templates.adoc @@ -1,7 +1,11 @@ +:_mod-docs-content-type: ASSEMBLY + [id="controller-workflow-job-templates"] = Workflow job templates +:context: worklow-job-templates + You can create both Job templates and Workflow job templates from {MenuAETemplates}. For Job templates, see xref:controller-job-templates[Job templates]. @@ -15,11 +19,15 @@ These resources include the following: * Inventory source syncs The *Automation Templates* page shows the workflow and job templates that are currently available. -The default view is to show each template as a card, showing the template name and template type. + +//The default view is to show each template as a card, showing the template name and template type. + Select the template name to display more information about the template, including when it last ran. This list is sorted alphabetically by name, but you can sort by other criteria, or search by various fields and attributes of a template. -From the template card you can launch image:rightrocket.png[Rightrocket,15,15], edit image:leftpencil.png[Leftpencil,15,15] a template, or, using the {MoreActionsIcon} icon, you can duplicate image:copy.png[Duplicate,15,15] or delete image:delete-button.png[Delete,15,15]a template. +From this screen you can launch image:rightrocket.png[Launch icon,15,15] , edit image:leftpencil.png[Edit icon,15,15], and duplicate image:copy.png[Duplicate icon, 15,15] a workflow job template. + +//From the template card you can launch image:rightrocket.png[Launch,15,15], edit image:leftpencil.png[Leftpencil,15,15] a template, or, using the {MoreActionsIcon} icon, you can duplicate image:copy.png[Duplicate,15,15] or delete image:delete-button.png[Delete,15,15]a template. Only workflow templates have the workflow visualizer image:visualizer.png[Workflow visualizer,15,15] icon as a shortcut for accessing the workflow editor. @@ -34,16 +42,29 @@ For further instructions, see the xref:controller-workflow-visualizer[Workflow v ==== include::platform/proc-controller-create-workflow-template.adoc[leveloffset=+1] + include::platform/con-controller-work-with-permissions.adoc[leveloffset=+1] + include::platform/con-controller-workflow-notifications.adoc[leveloffset=+1] + include::platform/con-controller-view-completed-workflow-jobs.adoc[leveloffset=+1] + include::platform/proc-controller-scheduling-workflow-job-templates.adoc[leveloffset=+1] + include::platform/con-controller-workflow-job-surveys.adoc[leveloffset=+1] + include::platform/con-controller-workflow-visualizer.adoc[leveloffset=+1] + include::platform/proc-controller-build-workflow.adoc[leveloffset=+2] + include::platform/ref-controller-approval-nodes.adoc[leveloffset=+2] + include::platform/proc-controller-building-nodes-scenarios.adoc[leveloffset=+2] + include::platform/proc-controller-edit-nodes.adoc[leveloffset=+2] + include::platform/proc-controller-launch-workflow-template.adoc[leveloffset=+1] + include::platform/proc-controller-copy-workflow-job-template.adoc[leveloffset=+1] + include::platform/ref-controller-workflow-job-template-extra-variables.adoc[leveloffset=+1] diff --git a/downstream/modules/platform/con-controller-work-with-permissions.adoc b/downstream/modules/platform/con-controller-work-with-permissions.adoc index 8ed4a03f9d..27c7224317 100644 --- a/downstream/modules/platform/con-controller-work-with-permissions.adoc +++ b/downstream/modules/platform/con-controller-work-with-permissions.adoc @@ -1,3 +1,5 @@ +:_mod-docs-content-type: CONCEPT + [id="controller-work-with-permissions"] = Work with permissions diff --git a/downstream/modules/platform/con-controller-workflow-notifications.adoc b/downstream/modules/platform/con-controller-workflow-notifications.adoc index 5d34e0b172..f005bca8ae 100644 --- a/downstream/modules/platform/con-controller-workflow-notifications.adoc +++ b/downstream/modules/platform/con-controller-workflow-notifications.adoc @@ -2,4 +2,4 @@ = Work with notifications -For information on working with notifications in workflow job templates, see xref:controller-work-with-notifications[Work with notifications]. +For information about working with notifications in workflow job templates, see xref:controller-work-with-notifications[Work with notifications]. diff --git a/downstream/modules/platform/proc-controller-build-workflow.adoc b/downstream/modules/platform/proc-controller-build-workflow.adoc index 63f38ab241..2be01eaa2f 100644 --- a/downstream/modules/platform/proc-controller-build-workflow.adoc +++ b/downstream/modules/platform/proc-controller-build-workflow.adoc @@ -17,7 +17,7 @@ You can set up any combination of two or more of the following node types to bui . To launch the workflow visualizer, use one of these methods: ** From the navigation panel, select {MenuAETemplates}. *** Select a workflow template and click btn:[View workflow visualizer]. -** From the *Templates* list view, click the image:visualizer.png[Visualizer,15,15] icon next to a workflow job template. +** From the *Automation Templates* list view, click the image:visualizer.png[Visualizer,15,15] icon next to a workflow job template. + //image::ug-wf-editor-create.png[Launch visualizer] + diff --git a/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc b/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc index a19fb65869..dcf732f23b 100644 --- a/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc +++ b/downstream/modules/platform/proc-controller-copy-workflow-job-template.adoc @@ -9,14 +9,14 @@ The user duplicating the workflow template is granted the administrator permissi .Procedure + . From the navigation panel, select {MenuAETemplates}. -. Click the {MoreActionIcon) icon associated with the template that you want to duplicate and select the image:copy.png[Duplicate Template,15,15] Duplicate Template icon. +. Click the image:options_menu.png[More options,15,15]) icon associated with the template that you want to duplicate and select the image:copy.png[Duplicate Template,15,15] Duplicate template icon. * The new template with the name of the template from which you duplicated and a timestamp displays in the list of templates. . Click to open the new template and click btn:[Edit template]. . Replace the contents of the *Name* field with a new name, and give or change the entries in the other fields to complete this page. . Click btn:[Save job template]. - [NOTE] ==== If a resource has a related resource that you do not have the right level of permission to, you cannot duplicate the resource. For example, in the case where a project uses a credential that a current user only has Read access. diff --git a/downstream/modules/platform/proc-controller-create-workflow-template.adoc b/downstream/modules/platform/proc-controller-create-workflow-template.adoc index 8a1adf91f5..617ee57cf1 100644 --- a/downstream/modules/platform/proc-controller-create-workflow-template.adoc +++ b/downstream/modules/platform/proc-controller-create-workflow-template.adoc @@ -1,7 +1,11 @@ +:_mod-docs-content-type: PROCEDURE + [id="controller-create-workflow-template"] = Creating a workflow job template +:context: create-worklow-job-templates + To create a new workflow job template, complete the following steps: [IMPORTANT]