Comply with DITA - Mng content (#4551)

Lennonka · maximiliankolb · Lennonka · commit dd01a5e69b70 · 2025-12-19T10:40:39.000+01:00
Co-authored-by: Maximilian Kolb &lt;mail@maximilian-kolb.de&gt;
diff --git a/guides/common/assembly_managing-application-lifecycles.adoc b/guides/common/assembly_managing-application-lifecycles.adoc
@@ -8,10 +8,18 @@ include::modules/con_content-promotion-across-the-application-lifecycle.adoc[lev
 
 include::modules/ref_best-practices-for-lifecycle-environments.adoc[leveloffset=+1]
 
-include::modules/proc_creating-a-lifecycle-environment-path.adoc[leveloffset=+1]
+include::modules/proc_creating-a-lifecycle-environment-path-by-using-web-ui.adoc[leveloffset=+1]
 
-include::modules/proc_adding-lifecycle-environments.adoc[leveloffset=+1]
+include::modules/proc_creating-a-lifecycle-environment-path-by-using-cli.adoc[leveloffset=+1]
 
-include::modules/proc_removing-lifecycle-environments-from-foreman.adoc[leveloffset=+1]
+include::modules/proc_adding-lifecycle-environments-by-using-web-ui.adoc[leveloffset=+1]
 
-include::modules/proc_removing-lifecycle-environments-from-smart-proxy.adoc[leveloffset=+1]
+include::modules/proc_adding-lifecycle-environments-by-using-cli.adoc[leveloffset=+1]
+
+include::modules/proc_removing-lifecycle-environments-from-foreman-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_removing-lifecycle-environments-from-foreman-by-using-cli.adoc[leveloffset=+1]
+
+include::modules/proc_removing-lifecycle-environments-from-smart-proxy-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_removing-lifecycle-environments-from-smart-proxy-by-using-cli.adoc[leveloffset=+1]
diff --git a/guides/common/assembly_performing-additional-configuration-on-smart-proxy-server.adoc b/guides/common/assembly_performing-additional-configuration-on-smart-proxy-server.adoc
@@ -13,7 +13,9 @@ include::modules/proc_configuring-pull-based-transport-for-remote-execution.adoc
 endif::[]
 
 ifdef::orcharhino,katello,satellite[]
-include::modules/proc_adding-lifecycle-environments.adoc[leveloffset=+1]
+include::modules/proc_adding-lifecycle-environments-by-using-web-ui.adoc[leveloffset=+1]
+
+include::modules/proc_adding-lifecycle-environments-by-using-cli.adoc[leveloffset=+1]
 endif::[]
 
 include::modules/proc_enabling-power-management-on-hosts.adoc[leveloffset=+1]
diff --git a/guides/common/modules/con_content-promotion-across-the-application-lifecycle.adoc b/guides/common/modules/con_content-promotion-across-the-application-lifecycle.adoc
@@ -3,10 +3,11 @@
 [id="Content_Promotion_across_the_Application_Lifecycle_{context}"]
 = Content promotion across the application lifecycle
 
+[role="_abstract"]
 In the application lifecycle chain, when content moves from one environment to the next, this is called _promotion_.
 
-.Example: Content promotion across {Project} lifecycle environments
-
+.Content promotion across {Project} lifecycle environments
+====
 Each environment contains a set of systems registered to {ProjectName}.
 These systems only have access to repositories relevant to their environment.
 When you promote packages from one environment to the next, the target environment's repositories receive new package versions.
@@ -66,5 +67,7 @@ After a successful review, promote the package to the _Production_ environment:
 
 | _example_software_-2.0-0.{client-pkg-arch}.{client-pkg-ext} | _example_software_-2.0-0.{client-pkg-arch}.{client-pkg-ext} | *_example_software_-2.0-0.{client-pkg-arch}.{client-pkg-ext}*
 |===
+====
 
-For more information, see xref:Promoting_a_Content_View_{context}[].
+.Additional resources
+* xref:Promoting_a_Content_View_{context}[]
diff --git a/guides/common/modules/con_introduction-to-application-lifecycle.adoc b/guides/common/modules/con_introduction-to-application-lifecycle.adoc
@@ -3,6 +3,7 @@
 [id="introduction_to_application_lifecycle_{context}"]
 = Introduction to application lifecycle
 
+[role="_abstract"]
 The _application lifecycle_ is a concept central to {Project}'s content management functions.
 The application lifecycle defines how a particular system and its software look at a particular stage.
 For example, an application lifecycle might be simple; you might only have a development stage and production stage.
diff --git a/guides/common/modules/con_managing-application-lifecycles.adoc b/guides/common/modules/con_managing-application-lifecycles.adoc
@@ -3,4 +3,5 @@
 [id="Managing_Application_Lifecycles_{context}"]
 = Managing application lifecycles
 
+[role="_abstract"]
 This chapter outlines the application lifecycle in {Project} and how to create and remove application lifecycles for {Project} and {SmartProxy}.
diff --git a/guides/common/modules/proc_adding-lifecycle-environments-by-using-cli.adoc b/guides/common/modules/proc_adding-lifecycle-environments-by-using-cli.adoc
@@ -1,25 +1,17 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="Adding_Lifecycle_Environments_{context}"]
-= Adding lifecycle environments to {SmartProxyServers}
+[id="adding-lifecycle-environments-by-using-cli"]
+= Adding lifecycle environments to {SmartProxyServers} by using Hammer CLI
 
+[role="_abstract"]
 If your {SmartProxyServer} has the content functionality enabled, you must add an environment so that {SmartProxy} can synchronize content from {ProjectServer} and provide content to host systems.
 
 Do not assign the _Library_ lifecycle environment to your {SmartProxyServer} because it triggers an automated {SmartProxy} sync every time the CDN updates a repository.
 This might consume multiple system resources on {SmartProxies}, network bandwidth between {Project} and {SmartProxies}, and available disk space on {SmartProxies}.
 
-You can use Hammer CLI on {ProjectServer} or the {ProjectWebUI}.
+You can add an environment by using Hammer CLI.
 
 .Procedure
-. In the {ProjectWebUI}, navigate to *Infrastructure* > *{SmartProxies}*, and select the {SmartProxy} that you want to add a lifecycle to.
-. Click *Edit* and click the *Lifecycle Environments* tab.
-. From the left menu, select the lifecycle environments that you want to add to {SmartProxy} and click *Submit*.
-. To synchronize the content on the {SmartProxy}, click the *Overview* tab and click *Synchronize*.
-. Select either *Optimized Sync* or *Complete Sync*.
-+
-For definitions of each synchronization type, see {ContentManagementDocURL}advanced-synchronization-for-repository-recovery[Advanced synchronization for repository recovery].
-
-.CLI procedure
 . To display a list of all {SmartProxyServers}, on {ProjectServer}, enter the following command:
 +
 [options="nowrap", subs="+quotes,verbatim,attributes"]
diff --git a/guides/common/modules/proc_adding-lifecycle-environments-by-using-web-ui.adoc b/guides/common/modules/proc_adding-lifecycle-environments-by-using-web-ui.adoc
@@ -0,0 +1,22 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="adding-lifecycle-environments-by-using-web-ui"]
+= Adding lifecycle environments to {SmartProxyServers} by using {ProjectWebUI}
+
+[role="_abstract"]
+If your {SmartProxyServer} has the content functionality enabled, you must add an environment so that {SmartProxy} can synchronize content from {ProjectServer} and provide content to host systems.
+
+Do not assign the _Library_ lifecycle environment to your {SmartProxyServer} because it triggers an automated {SmartProxy} sync every time the CDN updates a repository.
+This might consume multiple system resources on {SmartProxies}, network bandwidth between {Project} and {SmartProxies}, and available disk space on {SmartProxies}.
+
+You can add an environment from the {ProjectWebUI}.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Infrastructure* > *{SmartProxies}*.
+. Select your {SmartProxyServer} that you want to add a lifecycle to.
+. Click *Edit* and click the *Lifecycle Environments* tab.
+. From the left menu, select the lifecycle environments that you want to add to your {SmartProxyServer} and click *Submit*.
+. To synchronize the content to your {SmartProxyServer}, click the *Overview* tab and click *Synchronize*.
+. Select either *Optimized Sync* or *Complete Sync*.
++
+For definitions of each synchronization type, see {ContentManagementDocURL}advanced-synchronization-for-repository-recovery[Advanced synchronization for repository recovery].
diff --git a/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc b/guides/common/modules/proc_changing-the-content-source-of-a-host.adoc
@@ -17,7 +17,7 @@ Use this procedure to change the content source for a host.
 [NOTE]
 ====
 Some lifecycle environments can be unavailable for selection if they are not synced on the selected content source.
-For more information, see {ContentManagementDocURL}Adding_Lifecycle_Environments_content-management[Adding lifecycle environments to {SmartProxyServers}] in _{ContentManagementDocTitle}_.
+For more information, see {ContentManagementDocURL}adding-lifecycle-environments-by-using-web-ui[Adding lifecycle environments to {SmartProxyServers}] in _{ContentManagementDocTitle}_.
 ====
 . You can complete the content source change by using remote execution or manually.
 +
diff --git a/guides/common/modules/proc_creating-a-lifecycle-environment-path-by-using-cli.adoc b/guides/common/modules/proc_creating-a-lifecycle-environment-path-by-using-cli.adoc
@@ -1,20 +1,13 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="Creating_a_Lifecycle_Environment_Path_{context}"]
-= Creating a lifecycle environment path
+[id="creating-a-lifecycle-environment-path-by-using-cli"]
+= Creating a lifecycle environment path by using Hammer CLI
 
-To create an application lifecycle for developing and releasing software, use the _Library_ environment as the initial environment to create environment paths.
+[role="_abstract"]
+To create an application lifecycle for developing and releasing software by using Hammer CLI, use the _Library_ environment as the initial environment to create environment paths.
 Then optionally add additional environments to the environment paths.
 
 .Procedure
-. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Lifecycle Environments*.
-. Click *New Environment Path* to start a new application lifecycle.
-. In the *Name* field, enter a name for your environment.
-. In the *Description* field, enter a description for your environment.
-. Click *Save*.
-. Optional: To add an environment to the environment path, click *Add New Environment*, complete the *Name* and *Description* fields, and select the prior environment from the *Prior Environment* list.
-
-.CLI procedure
 . Create a lifecycle environment path by tying your first environment to Library:
 +
 [options="nowrap" subs="+quotes"]
diff --git a/guides/common/modules/proc_creating-a-lifecycle-environment-path-by-using-web-ui.adoc b/guides/common/modules/proc_creating-a-lifecycle-environment-path-by-using-web-ui.adoc
@@ -0,0 +1,16 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="creating-a-lifecycle-environment-path-by-using-web-ui"]
+= Creating a lifecycle environment path by using {ProjectWebUI}
+
+[role="_abstract"]
+To create an application lifecycle for developing and releasing software, use the _Library_ environment as the initial environment to create environment paths.
+Then optionally add additional environments to the environment paths.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Lifecycle Environments*.
+. Click *New Environment Path* to start a new application lifecycle.
+. In the *Name* field, enter a name for your environment.
+. In the *Description* field, enter a description for your environment.
+. Click *Save*.
+. Optional: To add an environment to the environment path, click *Add New Environment*, complete the *Name* and *Description* fields, and select the prior environment from the *Prior Environment* list.
diff --git a/guides/common/modules/proc_provisioning-from-a-builder-image-on-smartproxy.adoc b/guides/common/modules/proc_provisioning-from-a-builder-image-on-smartproxy.adoc
@@ -19,7 +19,7 @@ When you provision from a {LoraxCompose} image, Anaconda installer partitions di
 * An existing TAR image created by using {LoraxCompose} in {the-Cockpit}.
 Ensure that your blueprint to build the image includes the xref:packages-required-in-a-builder-image[required packages].
 * If you want to use {SmartProxyServer} URL, then the referenced lifecycle environment, such as Library, must be synchronized to that {SmartProxyServer}.
-For more information, see {InstallingSmartProxyDocURL}Adding_Lifecycle_Environments_{smart-proxy-context}[Adding lifecycle environments to {SmartProxyServers}] in _{InstallingSmartProxyDocTitle}_.
+For more information, see {InstallingSmartProxyDocURL}adding-lifecycle-environments-by-using-web-ui[Adding lifecycle environments to {SmartProxyServers}] in _{InstallingSmartProxyDocTitle}_.
 
 .Procedure
 . On {Project}, create a {customproduct}, add a {customfiletype} repository to this product, and upload the image to the repository.
diff --git a/guides/common/modules/proc_removing-lifecycle-environments-from-foreman-by-using-cli.adoc b/guides/common/modules/proc_removing-lifecycle-environments-from-foreman-by-using-cli.adoc
@@ -1,17 +1,12 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="Removing_Lifecycle_Environments_from_Server_{context}"]
-= Removing lifecycle environments from {ProjectServer}
+[id="removing-lifecycle-environments-from-server-by-using-cli"]
+= Removing lifecycle environments from {ProjectServer} by using Hammer CLI
 
-Use this procedure to remove a lifecycle environment.
+[role="_abstract"]
+Use this procedure to remove a lifecycle environment by using Hammer CLI.
 
 .Procedure
-. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle Environments*.
-. Click the name of the lifecycle environment that you want to remove, and then click *Remove Environment*.
-. Click *Remove* to remove the environment.
-
-[id="cli-Removing_Lifecycle_Environments_from_Server_{context}"]
-.CLI procedure
 . List the lifecycle environments for your organization and note the name of the lifecycle environment you want to remove:
 +
 [options="nowrap" subs="+quotes"]
diff --git a/guides/common/modules/proc_removing-lifecycle-environments-from-foreman-by-using-web-ui.adoc b/guides/common/modules/proc_removing-lifecycle-environments-from-foreman-by-using-web-ui.adoc
@@ -0,0 +1,12 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="removing-lifecycle-environments-from-server-by-using-web-ui"]
+= Removing lifecycle environments from {ProjectServer} by using {ProjectWebUI}
+
+[role="_abstract"]
+Use this procedure to remove a lifecycle environment from the {ProjectWebUI}.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle Environments*.
+. Click the name of the lifecycle environment that you want to remove, and then click *Remove Environment*.
+. Click *Remove* to remove the environment.
diff --git a/guides/common/modules/proc_removing-lifecycle-environments-from-smart-proxy-by-using-cli.adoc b/guides/common/modules/proc_removing-lifecycle-environments-from-smart-proxy-by-using-cli.adoc
@@ -1,20 +1,14 @@
 :_mod-docs-content-type: PROCEDURE
 
-[id="Removing_Lifecycle_Environments_from_{smart-proxy-context-titlecase}_{context}"]
-= Removing lifecycle environments from {SmartProxyServer}
+[id="removing-lifecycle-environments-from-{smart-proxy-context}-by-using-cli"]
+= Removing lifecycle environments from {SmartProxyServer} by using Hammer CLI
 
+[role="_abstract"]
 When lifecycle environments are no longer relevant to the host system or environments are added incorrectly to {SmartProxyServer}, you can remove the lifecycle environments from {SmartProxyServer}.
 
-You can use both the {ProjectWebUI} and the Hammer CLI to remove lifecycle environments from {SmartProxy}.
+You can use Hammer CLI to remove lifecycle environments from {SmartProxyServers}.
 
 .Procedure
-. In the {ProjectWebUI}, navigate to *Infrastructure* > *{SmartProxies}*, and select the {SmartProxy} that you want to remove a lifecycle from.
-. Click *Edit* and click the *Lifecycle Environments* tab.
-. From the right menu, select the lifecycle environments that you want to remove from {SmartProxy}, and then click *Submit*.
-. To synchronize {SmartProxy}'s content, click the *Overview* tab, and then click *Synchronize*.
-. Select either *Optimized Sync* or *Complete Sync*.
-
-.CLI procedure
 . Get a list of {SmartProxies}:
 +
 [options="nowrap", subs="verbatim,quotes,attributes"]
diff --git a/guides/common/modules/proc_removing-lifecycle-environments-from-smart-proxy-by-using-web-ui.adoc b/guides/common/modules/proc_removing-lifecycle-environments-from-smart-proxy-by-using-web-ui.adoc
@@ -0,0 +1,17 @@
+:_mod-docs-content-type: PROCEDURE
+
+[id="removing-lifecycle-environments-from-{smart-proxy-context}-by-using-web-ui"]
+= Removing lifecycle environments from {SmartProxyServer} by using {ProjectWebUI}
+
+[role="_abstract"]
+When lifecycle environments are no longer relevant to hosts or environments are added incorrectly to {SmartProxyServer}, you can remove the lifecycle environments from {SmartProxyServer}.
+
+You can use the {ProjectWebUI} to remove lifecycle environments from {SmartProxyServers}.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to *Infrastructure* > *{SmartProxies}*.
+. Select the {SmartProxyServer} that you want to remove a lifecycle from.
+. Click *Edit* and click the *Lifecycle Environments* tab.
+. From the right menu, select the lifecycle environments that you want to remove from {SmartProxyServer}, and then click *Submit*.
+. To synchronize content to your {SmartProxyServer}, click the *Overview* tab, and then click *Synchronize*.
+. Select either *Optimized Sync* or *Complete Sync*.
diff --git a/guides/common/modules/ref_best-practices-for-lifecycle-environments.adoc b/guides/common/modules/ref_best-practices-for-lifecycle-environments.adoc
@@ -3,6 +3,9 @@
 [id="best-practices-for-lifecycle-environments_{context}"]
 = Best practices for lifecycle environments
 
+[role="_abstract"]
+{Team} recommends you follow these practices for lifecycle environments.
+
 * Use multiple lifecycle environment paths to implement multiple sequential stages of content consumption.
 Each stage contains a defined set of content, for example in the _Production_ lifecycle environment.
 * Automate the creation of lifecycle environments by using a Hammer script or an {ansible-docs-url}[Ansible Playbook].

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ Use this procedure to change the content source for a host.`
`17`	`17`	`[NOTE]`
`18`	`18`	`====`
`19`	`19`	`Some lifecycle environments can be unavailable for selection if they are not synced on the selected content source.`
`20`		`-For more information, see {ContentManagementDocURL}Adding_Lifecycle_Environments_content-management[Adding lifecycle environments to {SmartProxyServers}] in _{ContentManagementDocTitle}_.`
	`20`	`+For more information, see {ContentManagementDocURL}adding-lifecycle-environments-by-using-web-ui[Adding lifecycle environments to {SmartProxyServers}] in _{ContentManagementDocTitle}_.`
`21`	`21`	`====`
`22`	`22`	`. You can complete the content source change by using remote execution or manually.`
`23`	`23`	`+`