Skip to content

Commit 3790a4f

Browse files
authored
Link fixes in getting started with AAP guide (#2358)
* link fixes in gs with aap guide * fixes broken links throughout guide * further cleanup
1 parent 1ffbe33 commit 3790a4f

15 files changed

+31
-60
lines changed

downstream/assemblies/platform/assembly-gs-auto-dev.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ include::platform/con-gs-setting-up-dev-env.adoc[leveloffset=+1]
2727
include::platform/con-gs-create-automation-content.adoc[leveloffset=+1]
2828
include::platform/con-gs-define-events-rulebooks.adoc[leveloffset=+1]
2929
include::platform/con-gs-ansible-roles.adoc[leveloffset=+1]
30-
include::platform/proc-gs-creating-a-role.adoc[leveloffset=+1]
30+
include::platform/proc-creating-ansible-role.adoc[leveloffset=+2]
3131
include::platform/con-gs-learn-about-collections.adoc[leveloffset=+1]
3232
include::platform/proc-gs-publish-to-a-collection.adoc[leveloffset=+1]
3333
include::platform/proc-gs-upload-collection.adoc[leveloffset=+2]
@@ -39,11 +39,11 @@ include::platform/proc-gs-auto-dev-set-up-decision-env.adoc[leveloffset=+2]
3939
include::platform/proc-gs-auto-dev-create-automation-execution-proj.adoc[leveloffset=+1]
4040
include::platform/proc-gs-auto-dev-create-automation-decision-proj.adoc[leveloffset=+1]
4141
include::platform/con-gs-auto-dev-about-inv.adoc[leveloffset=+1]
42-
include::platform/proc-controller-create-inventory.adoc[leveloffset=+2]
42+
// [hherbly] this repeats module above include::platform/proc-controller-create-inventory.adoc[leveloffset=+2]
4343
include::platform/con-gs-auto-dev-job-templates.adoc[leveloffset=+1]
4444
include::platform/proc-controller-getting-started-with-job-templates.adoc[leveloffset=+2]
4545
include::platform/proc-gs-auto-dev-create-template.adoc[leveloffset=+2]
46-
include::platform/proc-gs-auto-dev-run-template.adoc[leveloffset=+2]
46+
// [hherbly] incomplete module? include::platform/proc-gs-auto-dev-run-template.adoc[leveloffset=+2]
4747
include::platform/proc-controller-edit-job-template.adoc[leveloffset=+2]
4848
include::platform/con-gs-rulebook-activations.adoc[leveloffset=+1]
4949
include::platform/proc-gs-eda-set-up-rulebook-activation.adoc[leveloffset=+2]

downstream/assemblies/platform/assembly-gs-auto-op.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ include::platform/con-gs-ansible-roles.adoc[leveloffset=+1]
3131
include::platform/proc-creating-ansible-role.adoc[leveloffset=+2]
3232
include::platform/con-gs-ansible-content.adoc[leveloffset=+1]
3333
include::platform/con-gs-learn-about-collections.adoc[leveloffset=+2]
34-
include::platform/proc-gs-browse-content.adoc[leveloffset=+2]
34+
// [hherbly] removing because it repeats modules above include::platform/proc-gs-browse-content.adoc[leveloffset=+2]
3535
include::platform/proc-gs-downloading-content.adoc[leveloffset=+2]
3636
//
3737
include::platform/proc-gs-publish-to-a-collection.adoc[leveloffset=+1]

downstream/modules/platform/con-gs-ansible-roles.adoc

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,4 @@ A role is like a customized piece of automation content that bundles together re
66

77
Instead of creating huge playbooks with hundreds of tasks, you can use roles to break the tasks apart into smaller, more discrete units of work.
88

9-
To learn more about roles, see link:https://www.redhat.com/en/topics/automation/what-is-an-ansible-role#why-use-a-role-instead-of-a-playbook[What is an Ansible Role-and how is it used?].
10-
11-
== Creating a role
12-
13-
You can create roles using the Ansible Galaxy CLI tool, which is included with your {PlatformNameShort} bundle. Access role-specific commands from the roles subcommand:
14-
15-
[source,bash]
16-
----
17-
ansible-galaxy role init <role_name>
18-
----
19-
20-
Standalone roles outside of collections are still supported, but we recommend that you create new roles inside of a collection to take advantage of all the features {PlatformNameShort} has to offer.
9+
To learn more about roles, see link:https://www.redhat.com/en/topics/automation/what-is-an-ansible-role[What is an Ansible Role-and how is it used?].

downstream/modules/platform/con-gs-auto-dev-about-inv.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Use the following procedure to create a new inventory.
1818
* *Name*: Enter a name for the inventory.
1919
* Optional: *Description*: Enter a description.
2020
* *Organization*: Choose among the available organizations.
21-
* Only applicable to Smart Inventories: *Smart Host Filter*: Filters are similar to tags in that tags are used to filter certain hosts that contain those names. Therefore, to populate this field, specify a tag that contains the hosts you want, not the hosts themselves. Filters are case-sensitive. For more information, see link:{URLControllerUserGuide}/index#ref-controller-smart-host-filter[Smart host filters] in the {TitleControllerUserGuide} guide.
21+
* Only applicable to Smart Inventories: *Smart Host Filter*: Filters are similar to tags in that tags are used to filter certain hosts that contain those names. Therefore, to populate this field, specify a tag that contains the hosts you want, not the hosts themselves. Filters are case-sensitive. For more information, see link:{URLControllerUserGuide}/controller-inventories#ref-controller-smart-host-filter[Smart host filters] in the {TitleControllerUserGuide} guide.
2222
* *Instance groups*: Select the instance group or groups for this inventory to run on. If the list is extensive, use the search to narrow the options. You can select multiple instance groups and sort them in the order that you want them run.
2323
* Optional: *Labels*: Add labels that describe this inventory, so they can be used to group and filter inventories and jobs.
2424
* Only applicable to constructed inventories: *Input inventories*: Specify the source inventories to include in this constructed inventory. Empty groups from input inventories are copied into the constructed inventory.
@@ -27,7 +27,7 @@ Use the following procedure to create a new inventory.
2727
** Verbose logging includes the output of all commands.
2828
** Debug logging is exceedingly verbose and includes information on SSH operations that can be useful in certain support instances. Most users do not need to see debug mode output.
2929
* Only applicable to constructed inventories: *Limit*: Restricts the number of returned hosts for the inventory source associated with the constructed inventory. You can paste a group name into the limit field to only include hosts in that group. For more information, see the *Source variables* setting.
30-
* Only applicable to standard inventories: *Options*: Check the box next to *Prevent instance group fallback* to enable only the instance groups listed in the *Instance groups* field to execute the job. If unchecked, all available instances in the execution pool will be used based on the hierarchy described in link:{URLControllerAdminGuide}/controller-instance-and-container-groups#controller-control-job-run[Control where a job runs] in the {TitleControllerAdminGuide} guide. Click the tooltip for more information.
30+
* Only applicable to standard inventories: *Options*: Check the box next to *Prevent instance group fallback* to enable only the instance groups listed in the *Instance groups* field to execute the job. If unchecked, all available instances in the execution pool will be used based on the hierarchy described in link:{URLControllerAdminGuide}/controller-clustering#controller-cluster-job-runs[Control where a job runs] in the {TitleControllerAdminGuide} guide. Click the tooltip for more information.
3131
+
3232
NOTE: Set the `prevent_instance_group_fallback` option for smart inventories through the API.
3333
+

downstream/modules/platform/con-gs-auto-op-execute-inv.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ The *Inventories* window displays a list of inventories that are currently avail
1515
* *Organization*: The organization to which the inventory belongs.
1616
. Select an inventory name to display the *Details* page for the inventory, including the inventory's groups and hosts.
1717

18-
For more information about inventories, see the link:{URLControllerUserGuide}/index#controller-inventories[Inventories] section of the {TitleControllerUserGuide} guide.
18+
For more information about inventories, see the link:{URLControllerUserGuide}/controller-inventories[Inventories] section of the {TitleControllerUserGuide} guide.
1919

downstream/modules/platform/con-gs-auto-op-job-templates.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44

55
A job template is a definition and set of parameters for running an Ansible job.
66

7-
A job template combines an Ansible Playbook from a project with the settings required to launch the job. Job templates are useful for running the same job many times. Job templates also encourage the reuse of Ansible Playbook content and collaboration between teams. For more information, see link:{URLControllerUserGuide}/index#controller-job-templates[Job Templates] in the {TitleControllerUserGuide} guide.
7+
A job template combines an Ansible Playbook from a project with the settings required to launch the job. Job templates are useful for running the same job many times. Job templates also encourage the reuse of Ansible Playbook content and collaboration between teams. For more information, see link:{URLControllerUserGuide}/controller-job-templates[Job Templates] in the {TitleControllerUserGuide} guide.
88

99
Platform administrators and automation developers have the permissions to create job templates. As an automation operator you can launch job templates and view their details.

downstream/modules/platform/con-gs-learn-about-collections.adoc

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,6 @@ Ansible content collections are assemblages of automation content. There are two
77
* *{CertifiedName}*, which contain fully-supported roles and modules that are enterprise- and production-ready for use in your environments.
88
* *{Valid} collections*, which provide you with a trusted, expert-guided approach for performing foundational operations and tasks in your product.
99

10-
Both types of content collections can be found in {HubName} through the link:{Console}[Hybrid Cloud Console].
10+
Both types of content collections can be found in {HubName} through the link:https://console.redhat.com/ansible/automation-hub/[Hybrid Cloud Console].
1111

12-
== Downloading content
13-
14-
After collections are finalized, you can import them to a location where they can be distributed to others across your organization.
15-
16-
.Procedure
17-
18-
. Log in to {PlatformName}.
19-
. From the navigation panel, select {MenuACCollections}.
20-
The *Collections* page displays all collections across all repositories.
21-
You can search for a specific collection.
22-
. Select the collection that you want to export.
23-
The collection details page opens.
24-
. From the *Install* tab, select *Download tarball*.
25-
The .tar file is downloaded to your default browser downloads folder.
26-
You can now import it to the location of your choosing.
2712

downstream/modules/platform/proc-creating-ansible-role.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
You can create roles using the {Galaxy} CLI tool, which is included with your {PlatformNameShort} bundle. Access role-specific commands from the `role` subcommand:
66

7+
[source,bash]
8+
----
9+
ansible-galaxy role init <role_name>
10+
----
11+
712
Standalone roles outside of Collections are supported.
813
Create new roles inside a Collection to take advantage of the features {PlatformNameShort} has to offer.
914

@@ -50,6 +55,3 @@ $ ansible-galaxy role init my_role --role-skeleton ~/role_skeleton
5055
+
5156
This creates a role named `my_role` by copying the contents of `~/role_skeleton` into `my_role`.
5257
The contents of `role_skeleton` can be any files or folders that are valid inside a role directory.
53-
54-
For more information on creating roles, see [Aine’s new devtools content].
55-

downstream/modules/platform/proc-gs-add-ee-to-job-template.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
.Prerequisites
66

7-
* An {ExecEnvShort} must have been created using ansible-builder as described in link:{URLBuilder}/index#assembly-using-builder[Using {Builder}].
7+
* An {ExecEnvShort} must have been created using ansible-builder as described in link:{URLBuilder}/assembly-using-builder[Using {Builder}].
88
When an {ExecEnvShort} has been created, you can use it to run jobs.
99
Use the {ControllerName} UI to specify the execution environment to use in your job templates.
1010
* Depending on whether an {ExecEnvShort} is made available for global use or tied to an organization, you must have the appropriate level of administrator privileges to use an {ExecEnvShort} in a job.
@@ -38,4 +38,4 @@ When you have added an {ExecEnvShort} to a job template, the template will be li
3838

3939
If you have many {ExecEnvShort} that you want to maintain, you can store them in a container registry linked to your {PrivateHubName}.
4040

41-
For more information, see link:{URLBuilder}/index#populate-container-registry[Populating your private automation hub container registry] from the {TitleBuilder} guide.
41+
For more information, see link:{URLBuilder}/populate-container-registry[Populating your private automation hub container registry] from the {TitleBuilder} guide.

downstream/modules/platform/proc-gs-auto-dev-create-automation-execution-proj.adoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,21 @@ You can set up an automation execution project in the platform UI.
99

1010
.Procedure
1111

12-
Procedure
1312
. From the navigation panel, select {MenuAEProjects}.
1413
. On the *Projects* page, click btn:[Create project] to launch the *Create Project* window.
15-
+
16-
//image:projects-create-new-project.png[Projects- create new project]
17-
1814
. Enter the appropriate details into the following required fields:
1915

2016
* *Name* (required)
2117
* Optional: *Description*
2218
* *Organization* (required): A project must have at least one organization. Select one organization now to create the project. When the project is created you can add additional organizations.
2319
* Optional: *Execution Environment*: Enter the name of the {ExecEnvShort} or search from a list of existing ones to run this project.
24-
For more information, see link:{URLUpgrade}/upgrading-to-ees[Migrating to automation execution environments] in the {TitleUpgrade}.
2520
* *Source Control Type* (required): Select an SCM type associated with this project from the menu.
2621
Options in the following sections become available depending on the type chosen.
27-
For more information, see link:{URLControllerUserGuide}/index#proc-projects-manage-playbooks-manually[Managing playbooks manually] or link:{URLControllerUserGuide}/index#ref-projects-manage-playbooks-with-source-control[Managing playbooks using source control].
22+
For more information, see link:{URLControllerUserGuide}/controller-projects#proc-controller-adding-a-project[Managing playbooks manually] or link:{URLControllerUserGuide}/controller-projects#ref-projects-manage-playbooks-with-source-control[Managing playbooks using source control].
2823
* Optional: *Content Signature Validation Credential*: Use this field to enable content verification.
2924
Specify the GPG key to use for validating content signature during project synchronization.
3025
If the content has been tampered with, the job will not run.
31-
For more information, see link:{URLControllerUserGuide}/index#assembly-controller-project-signing[Project signing and verification].
26+
For more information, see link:{URLControllerUserGuide}/assembly-controller-project-signing[Project signing and verification].
27+
+
3228
. Click btn:[Create project].
3329

0 commit comments

Comments
 (0)