Optimize (CQA) - Managing Content - RH Subs by Lennonka · Pull Request #4738 · theforeman/foreman-documentation

Lennonka · 2026-03-25T19:34:26Z

What changes are you introducing?

Improving the Managing Red Hat subscriptions chapter of Managing content

optimization of abstracts
optimization of prerequisites (wording)
refactored one module
renamed and changed content type of RH CDN module

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

Title and abstract optimization: SEO and GEO (AI-friendly)
Declarative wording for prerequisites (as opposed to imperative)
Part of Content Quality Assessment for DITA migration

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

AI + human
This shouldn't require tech review, but let me know if unsure.

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.18/Katello 4.20 (Satellite 6.19)
Foreman 3.17/Katello 4.19
Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6 and 7.7)
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.

github-actions · 2026-03-25T19:38:42Z

The PR preview for 97370c8 is available at theforeman-foreman-documentation-preview-pr-4738.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

guides/common/modules/ref_red-hat-cdn-structure.adoc

Lennonka · 2026-04-01T14:23:26Z

Rebased.

guides/common/modules/proc_obtaining-a-red-hat-subscription-manifest.adoc

guides/common/modules/con_importing-a-subscription-manifest-into-foreman-server.adoc

Lennonka · 2026-04-01T20:37:30Z

This is now ready for review.

maximiliankolb

I made a few minor suggestions.

guides/common/modules/proc_tracking-subscription-usage-by-using-the-subscriptions-service.adoc

guides/common/modules/ref_red-hat-cdn-structure.adoc

Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>

Lennonka · 2026-04-07T15:07:40Z

@maximiliankolb All good?

guides/common/modules/proc_tracking-subscription-usage-by-using-the-subscriptions-service.adoc

Lennonka · 2026-04-07T16:37:11Z

guides/common/modules/proc_tracking-subscription-usage-by-using-the-subscriptions-service.adoc

I'm not happy with this module, but it looks like a future me/JTBD problem. 😁

maximiliankolb

All good.

Part of Content Quality Assessment (CQA) for DITA migration Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>

Lennonka · 2026-04-09T10:14:42Z

Cherry picked:

f9fbd96..35f74c0 3.18 -> 3.18
331257a..ef541f4 3.17 -> 3.17
9979d27..c64b45d 3.16 -> 3.16

pr-processor bot added the Not yet reviewed label Mar 25, 2026

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 Mar 25, 2026

Lennonka added this to the Prepare for DITA migration (RH) milestone Mar 25, 2026

Lennonka removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Mar 25, 2026

Lennonka marked this pull request as ready for review March 25, 2026 20:53

Lennonka commented Mar 26, 2026

View reviewed changes

guides/common/modules/ref_red-hat-cdn-structure.adoc Outdated Show resolved Hide resolved

pr-processor bot removed the Not yet reviewed label Mar 26, 2026

Lennonka marked this pull request as draft March 26, 2026 14:55

Lennonka marked this pull request as ready for review March 26, 2026 19:11

Lennonka marked this pull request as draft March 26, 2026 21:14

Lennonka force-pushed the premig-mng-content-rhsubs branch from 80538aa to bf92561 Compare March 30, 2026 12:14

This comment was marked as outdated.

Sign in to view

Lennonka added 6 commits April 1, 2026 16:21

Improve short descriptions

f2f540d

Retitle and change content type

789df5a

Elaborate on subscription manifests

a9440ba

Simplify

42febd3

fixup

fadf4d1

Remove note

37c9ca4

Lennonka force-pushed the premig-mng-content-rhsubs branch from bf92561 to 37c9ca4 Compare April 1, 2026 14:23

Lennonka added 2 commits April 1, 2026 21:03

Optimize prerequisites

21da4a2

Improve wording

a4b80a1

Lennonka commented Apr 1, 2026

View reviewed changes

guides/common/modules/proc_obtaining-a-red-hat-subscription-manifest.adoc Outdated Show resolved Hide resolved

Lennonka commented Apr 1, 2026

View reviewed changes

guides/common/modules/con_importing-a-subscription-manifest-into-foreman-server.adoc Outdated Show resolved Hide resolved

Lennonka added 2 commits April 1, 2026 21:30

Drop hallucinated prereq

3f19614

Move endif

3711265

Lennonka added 6 commits April 1, 2026 21:31

Drop fluff

5668e8a

Improve wording

66b344d

Refactor module

be0e56c

Use Project instead of ProjectServer

c45927d

Simplify procedure steps

b77492a

Fix Next steps

db4cd69

Lennonka force-pushed the premig-mng-content-rhsubs branch from 5bb108f to db4cd69 Compare April 1, 2026 20:34

Lennonka marked this pull request as ready for review April 1, 2026 20:37

maximiliankolb reviewed Apr 2, 2026

View reviewed changes

Lennonka and others added 4 commits April 7, 2026 04:41

Apply simple suggestions from review

7da1dd4

Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>

Apply simple suggestion

a5a33fe

Fix grammar in title

2dd616d

Improve CDN auth wording

e0cc7d1

Lennonka commented Apr 7, 2026

View reviewed changes

guides/common/modules/proc_tracking-subscription-usage-by-using-the-subscriptions-service.adoc Outdated Show resolved Hide resolved

Apply suggestion

97370c8

Lennonka commented Apr 7, 2026

View reviewed changes

maximiliankolb approved these changes Apr 8, 2026

View reviewed changes

Lennonka added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Apr 8, 2026

Lennonka merged commit c7e70de into theforeman:master Apr 9, 2026
10 of 11 checks passed

Lennonka added a commit that referenced this pull request Apr 9, 2026

Optimize title, abstract, and prerequisites (#4738)

35f74c0

Part of Content Quality Assessment (CQA) for DITA migration Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>

Lennonka added a commit that referenced this pull request Apr 9, 2026

Optimize title, abstract, and prerequisites (#4738)

ef541f4

Part of Content Quality Assessment (CQA) for DITA migration Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>

Lennonka added a commit that referenced this pull request Apr 9, 2026

Optimize title, abstract, and prerequisites (#4738)

c64b45d

Part of Content Quality Assessment (CQA) for DITA migration Co-authored-by: Maximilian Kolb <mail@maximilian-kolb.de>

Lennonka deleted the premig-mng-content-rhsubs branch April 9, 2026 10:14

Conversation

Lennonka commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes are you introducing?

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

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

Contributor checklists

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Lennonka commented Apr 1, 2026

Uh oh!

Uh oh!

Uh oh!

Lennonka commented Apr 1, 2026

Uh oh!

maximiliankolb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lennonka commented Apr 7, 2026

Uh oh!

Uh oh!

Lennonka Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maximiliankolb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Lennonka commented Apr 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Lennonka commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading

Lennonka Apr 7, 2026 •

edited

Loading