Skip to content

Reword abstract of compute profile for Azure#4580

Open
maximiliankolb wants to merge 1 commit intotheforeman:masterfrom
ATIX-AG:reword_azure_compute_profile
Open

Reword abstract of compute profile for Azure#4580
maximiliankolb wants to merge 1 commit intotheforeman:masterfrom
ATIX-AG:reword_azure_compute_profile

Conversation

@maximiliankolb
Copy link
Contributor

What changes are you introducing?

Reword abstract.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Refs PR to DITAfy Provisioning Hosts guide.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Wording is based on
"guides/common/modules/proc_adding-gce-details-to-a-compute-profile-by-using-web-ui.adoc".

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • We do not accept PRs for Foreman older than 3.12.

Wording is based on
"guides/common/modules/proc_adding-gce-details-to-a-compute-profile-by-using-web-ui.adoc".
@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Jan 13, 2026
@maximiliankolb maximiliankolb removed Needs tech review Requires a review from the technical perspective Not yet reviewed Needs testing Requires functional testing labels Jan 13, 2026
@jafiala jafiala assigned jafiala and unassigned jafiala Jan 13, 2026

[role="_abstract"]
To standardize and more efficiently manage the deployment of your cloud instances in the Azure cloud, add Microsoft Azure hardware settings to a compute profile.
You can add Microsoft Azure hardware settings to a compute profile.
Copy link
Contributor

Choose a reason for hiding this comment

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

I still think the abstract should have the WHY, otherwise it's just repeating what's in the title, which is redundant.

Suggested change
You can add Microsoft Azure hardware settings to a compute profile.
You can add Microsoft Azure hardware settings to a compute profile to standardize and more efficiently manage the deployment of your cloud instances in the Azure cloud.

We can have a different WHY of course, but there should be at least one reason for why users may want to perform the procedure.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I looked at all other files, none do this; azure via WebUI is the outlier:

$ fd to-a-compute-profile-by-
guides/common/modules/proc_adding-amazon-ec2-details-to-a-compute-profile-by-using-cli.adoc
guides/common/modules/proc_adding-amazon-ec2-details-to-a-compute-profile-by-using-web-ui.adoc
guides/common/modules/proc_adding-gce-details-to-a-compute-profile-by-using-cli.adoc
guides/common/modules/proc_adding-gce-details-to-a-compute-profile-by-using-web-ui.adoc
guides/common/modules/proc_adding-kvm-details-to-a-compute-profile-by-using-cli.adoc
guides/common/modules/proc_adding-kvm-details-to-a-compute-profile-by-using-web-ui.adoc
guides/common/modules/proc_adding-microsoft-azure-resource-manager-details-to-a-compute-profile-by-using-cli.adoc
guides/common/modules/proc_adding-microsoft-azure-resource-manager-details-to-a-compute-profile-by-using-web-ui.adoc
guides/common/modules/proc_adding-openstack-details-to-a-compute-profile-by-using-cli.adoc
guides/common/modules/proc_adding-openstack-details-to-a-compute-profile-by-using-web-ui.adoc
guides/common/modules/proc_adding-vmware-details-to-a-compute-profile-by-using-cli.adoc
guides/common/modules/proc_adding-vmware-details-to-a-compute-profile-by-using-web-ui.adoc

KVM is also slighty different:

guides/common/modules/proc_adding-kvm-details-to-a-compute-profile-by-using-web-ui.adoc
7:You can create standardized virtual machines more quickly and efficiently by adding KVM hardware settings to a compute profile.

guides/common/modules/proc_adding-kvm-details-to-a-compute-profile-by-using-cli.adoc
7:You can create standardized virtual machines more quickly and efficiently by adding KVM hardware settings to a compute profile.

IMO standardization happens at the level of host groups and later via configuration management. Compute profiles more or less define the "size" of the VM/cloud instance.

See the DB seeds in foreman:

$ cat db/seeds.d/130-compute_profiles.rb | rg ":name"
      { :name => '1-Small' },
      { :name => '2-Medium' },
      { :name => '3-Large' },

@Lennonka Lennonka added the Waiting on contributor Requires an action from the author label Jan 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs style review Requires a review from docs style/grammar perspective Waiting on contributor Requires an action from the author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants