Skip to content

Comply with DITA - Using Hammer - missing abstracts #4401

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Comply with DITA - Using Hammer - missing abstracts #4401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63f061f
Comply with DITA - add missing abstracts
Lennonka Oct 22, 2025
f353323
Mention ProjectName
Lennonka Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions guides/common/modules/ref_activation-keys.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='activation-keys']
== Activation keys

[role="_abstract"]
Learn the Hammer CLI commands for creating activation keys and adding subscriptions in {ProjectName}.
You use these commands to manage activation keys that automatically configure systems during registration.
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You use these commands to manage activation keys that automatically configure systems during registration.
You use these commands to manage activation keys that automatically configure hosts during registration.

IMO "configure hosts" is a bit of a stretch. Configuring what? subscription-manager uses AK (and CV envs) to setup content that hosts can consume.

Refs https://docs.theforeman.org/nightly/Managing_Hosts/index-katello.html#registering-a-host_managing-hosts


[cols="3a,7a",options="header",]
|====
|Subcommand |Description and tasks
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_content-life-cycles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='content-life-cycles']
== Content life cycles

[role="_abstract"]
Learn the Hammer CLI commands for managing lifecycle environments and content views in {ProjectName}.
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Learn the Hammer CLI commands for managing lifecycle environments and content views in {ProjectName}.
Learn the Hammer CLI commands for managing content views in lifecycle environments in {ProjectName}.

You use these commands to control content promotion and version management across environments.
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You use these commands to control content promotion and version management across environments.
You use these commands to promote content across lifecycle environments.


[cols="3a,7a",options="header",subs="+quotes"]
|====
|Subcommand |Description and tasks
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_errata.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='errata']
== Errata

[role="_abstract"]
Learn the Hammer CLI commands for managing security updates and patches in {ProjectName}.
You use these commands to list, inspect, and apply errata to keep your systems secure and up-to-date.
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You use these commands to list, inspect, and apply errata to keep your systems secure and up-to-date.
You use these commands to list, inspect, and apply errata to keep your hosts secure and up-to-date.


[cols="3a,7a",options="header",subs="+quotes"]
|====
|Subcommand |Description and tasks
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_general-information.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='general-information']
== General information

[role="_abstract"]
Learn essential information for using Hammer CLI in {ProjectName} effectively.
You need to understand authentication, help options, and organization requirements before executing commands.
Comment on lines +7 to +8
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Learn essential information for using Hammer CLI in {ProjectName} effectively.
You need to understand authentication, help options, and organization requirements before executing commands.
There are certain options for using Hammer CLI in {ProjectName} that apply to all commands, including authentication and getting help.


Before you start reading the Hammer cheat sheet, familiarize yourself with the following information.

Authentication in examples::
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_hosts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='hosts']
== Hosts

[role="_abstract"]
Learn the Hammer CLI commands for managing hosts, host groups, and remote job execution in {ProjectName}.
You use these commands to create and configure systems, organize them into groups, and execute tasks remotely.
Comment on lines +7 to +8
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Learn the Hammer CLI commands for managing hosts, host groups, and remote job execution in {ProjectName}.
You use these commands to create and configure systems, organize them into groups, and execute tasks remotely.
Learn the Hammer CLI commands for managing hosts, host groups, and remote job execution in {ProjectName}.
You use these commands to configure host group and to create hosts.

IMO organizing them into groups would be host collections. host group are more like blueprints.


[cols="3a,7a",options="header",]
|====
|Subcommand |Description and tasks
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_orgs-locs-and-repos.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='organizations-locations-and-repositories']
== Organizations, locations, and repositories

[role="_abstract"]
Learn the Hammer CLI commands for managing organizations, locations, and repositories.
You use these commands to structure your environment and manage content synchronization.
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You use these commands to structure your environment and manage content synchronization.


[cols="3a,7a",options="header",]
|====
|Subcommand |Description and tasks
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_provisioning-environments.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='provisioning-environments']
== Provisioning environments

[role="_abstract"]
Learn the Hammer CLI commands for creating provisioning infrastructure components in {ProjectName}.
You use these commands to set up domains, subnets, compute resources, and templates for automated system deployment.
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You use these commands to set up domains, subnets, compute resources, and templates for automated system deployment.
You use these commands to set up domains, subnets, compute resources, and templates for automated host provisioning.

IMO it's nice if we stick closer to the name of the guide & avoid using different terminology.


[cols="3a,7a",options="header",]
|====

Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_tasks.adoc
View file
Open in desktop
Copy link
Contributor

@maximiliankolb maximiliankolb Oct 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

out of scope: https://docs.theforeman.org/nightly/Hammer_CLI/index-katello.html#tasks looks off. IMO there should be a second row starting with "Monitor progress...".

Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='tasks']
== Tasks

[role="_abstract"]
Learn the Hammer CLI commands for listing tasks and monitoring their progress in {ProjectName}.
You use these commands to track running operations and troubleshoot issues.

[cols="3a,7a",options="header",]
|====
|Subcommand |Description and tasks
Expand Down
4 changes: 4 additions & 0 deletions guides/common/modules/ref_users-and-permissions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
[id='users-and-permissions']
== Users and permissions

[role="_abstract"]
Learn the Hammer CLI commands for managing users, user groups, roles, and filters in {ProjectName}.
You use these commands to control access and permissions within your {Project}.

[cols="3a,7a",options="header",]
|====
|Subcommand |Description and tasks
Expand Down
Loading