Split off Hammer reference into separate guide (#4220)

Lennonka · web-flow · commit 66ef56b80c20 · 2025-09-08T15:56:41.000+02:00
diff --git a/guides/common/assembly_hammer-reference.adoc b/guides/common/assembly_hammer-reference.adoc
diff --git a/guides/common/attributes-base.adoc b/guides/common/attributes-base.adoc
@@ -8,6 +8,7 @@
 :ConfiguringUserAuthenticationDocURL: {BaseURL}Configuring_User_Authentication/{BaseFilenameURL}#
 :ContentManagementDocURL: {BaseURL}Managing_Content/{BaseFilenameURL}#
 :HammerDocURL: {BaseURL}Hammer_CLI/{BaseFilenameURL}#
+:HammerRefDocURL: {BaseURL}Hammer_Reference/{BaseFilenameURL}#
 :InstallingServerDisconnectedDocURL: {BaseURL}Installing_Server_Disconnected/{BaseFilenameURL}#
 :InstallingServerDocURL: {BaseURL}Installing_Server/{BaseFilenameURL}#
 :InstallingSmartProxyDocURL: {BaseURL}Installing_Proxy/{BaseFilenameURL}#
diff --git a/guides/common/attributes-satellite.adoc b/guides/common/attributes-satellite.adoc
@@ -25,6 +25,7 @@
 :InstallingServerDocURL: {BaseURL}installing_satellite_server_in_a_connected_network_environment/index#
 :InstallingSmartProxyDocURL: {BaseURL}installing_capsule_server/index#
 :HammerDocURL: {BaseURL}using_the_hammer_cli_tool/index#
+:HammerRefDocURL: {BaseURL}hammer_reference/index#
 :ManagingConfigurationsAnsibleDocURL: {BaseURL}managing_configurations_by_using_ansible_integration/index#
 :ManagingConfigurationsPuppetDocURL: {BaseURL}managing_configurations_by_using_puppet_integration/index#
 :ManagingHostsDocURL: {BaseURL}managing_hosts/index#
diff --git a/guides/common/attributes-titles.adoc b/guides/common/attributes-titles.adoc
@@ -12,6 +12,7 @@
 :ConvertingHostRHELDocTitle: Converting a host to RHEL
 :DeployingAWSDocTitle: Deploying {ProjectName} on Amazon Web Services
 :HammerDocTitle: Using the Hammer CLI tool
+:HammerRefDocTitle: Hammer reference
 :InstallingServerDocTitle: Installing {ProjectServerTitle} {ProjectVersion} on {install-on-os}
 :InstallingServerCTLDocTitle: Installing {ProjectServerTitle} {ProjectVersion} on {install-on-os} by using foremanctl
 // Installing Disconnected - defined for Satellite only
diff --git a/guides/common/modules/con_hammer-reference.adoc b/guides/common/modules/con_hammer-reference.adoc
diff --git a/guides/common/modules/con_introduction-to-hammer.adoc b/guides/common/modules/con_introduction-to-hammer.adoc
@@ -6,3 +6,6 @@
 Hammer is a powerful command-line tool provided with {ProjectNameX}.
 You can use Hammer to configure and manage a {ProjectServer} either through CLI commands or automation in shell scripts.
 Hammer also provides an interactive shell.
+
+.Additional resources
+* {HammerRefDocURL}[{HammerRefDocTitle}]
diff --git a/guides/doc-Hammer_CLI/master.adoc b/guides/doc-Hammer_CLI/master.adoc
@@ -64,9 +64,6 @@ include::common/modules/ref_hosts.adoc[leveloffset=+1]
 
 include::common/modules/ref_tasks.adoc[leveloffset=+1]
 
-// Use the generate-hammer-reference.sh script to update
-include::common/assembly_hammer-reference.adoc[leveloffset=+1]
-
 ifndef::orcharhino,satellite[]
 include::common/ribbons.adoc[]
 endif::[]
diff --git a/guides/doc-Hammer_Reference/Makefile b/guides/doc-Hammer_Reference/Makefile
@@ -0,0 +1 @@
+include ../common/Makefile
diff --git a/guides/doc-Hammer_Reference/README.md b/guides/doc-Hammer_Reference/README.md
diff --git a/guides/doc-Hammer_Reference/common b/guides/doc-Hammer_Reference/common
@@ -0,0 +1 @@
+../common
diff --git a/guides/doc-Hammer_Reference/docinfo.xml b/guides/doc-Hammer_Reference/docinfo.xml
@@ -0,0 +1,14 @@
+<title>{HammerRefDocTitle}</title>
+<productname>Red Hat Satellite</productname>
+<productnumber>{ProjectVersion}</productnumber>
+<subtitle>Review commands and options of Hammer, the Satellite command-line tool</subtitle>
+<abstract><para>This document provides a complete reference for the Hammer CLI tool in Red Hat Satellite.</para></abstract>
+<authorgroup id="Author_Group">
+        <author>
+                <firstname>Red Hat Satellite</firstname>
+                <surname>Documentation Team</surname>
+                <email>satellite-doc-list@redhat.com</email>
+        </author>
+</authorgroup>
+
+<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
diff --git a/guides/doc-Hammer_Reference/images/common b/guides/doc-Hammer_Reference/images/common
@@ -0,0 +1 @@
+../../common/images
diff --git a/guides/doc-Hammer_Reference/master.adoc b/guides/doc-Hammer_Reference/master.adoc
@@ -0,0 +1,17 @@
+include::common/attributes.adoc[]
+include::common/header.adoc[]
+:context: hammer-reference
+:hammer-reference:
+
+= {HammerRefDocTitle}
+
+ifdef::satellite[]
+include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1]
+endif::[]
+
+// DO NOT EDIT MANUALLY!
+// Use the generate-hammer-reference.sh script to update
+
+ifndef::orcharhino,satellite[]
+include::common/ribbons.adoc[]
+endif::[]
