Skip to content

Optimize (CQA) - Managing Content - ACS#4756

Open
Lennonka wants to merge 3 commits intotheforeman:masterfrom
Lennonka:premig-mng-content-acs
Open

Optimize (CQA) - Managing Content - ACS#4756
Lennonka wants to merge 3 commits intotheforeman:masterfrom
Lennonka:premig-mng-content-acs

Conversation

@Lennonka
Copy link
Copy Markdown
Contributor

@Lennonka Lennonka commented Apr 7, 2026 •
edited
Loading

What changes are you introducing?

Improving the Managing ACS chapter of Managing content

  • optimization of abstracts
  • optimization of prerequisites
  • refactored procedure modules to use singular for ACS

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
  • Tech review for abstracts requested.

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 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 Apr 7, 2026
@Lennonka Lennonka removed the Needs testing Requires functional testing label Apr 7, 2026
@Lennonka Lennonka changed the title Premig mng content acs Optimize (CQA) - Managing Content - ACS Apr 7, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 7, 2026

The PR preview for e38568c is available at theforeman-foreman-documentation-preview-pr-4756.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Lennonka
Lennonka commented Apr 7, 2026
View reviewed changes
guides/common/modules/proc_creating-an-rhui-alternate-content-source-by-using-cli.adoc
# rhui-manager repo info --repo_id _My_Repo_ID_
----
+
Record the relative paths from the command output to use as subpaths.
Copy link
Copy Markdown
Contributor Author

@Lennonka Lennonka Apr 7, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

The relative path looks as follows according to the RHUI4 docs:

Relative Path:       content/dist/rhel8/rhui/8.4/aarch64/appstream/os

If people use it as-is for a subpath, they might get the full URL like:

https://rhui-cds-node.example.com/pulp/content/content/dist/rhel8/rhui/8.4/aarch64/appstream/os

Is that expected?
Or does Foreman handle the double content substring somehow?

Copy link
Copy Markdown
Contributor

@ianballou ianballou Apr 7, 2026

Choose a reason for hiding this comment

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

It's been a while since I've looked at RHUI, but the double content was intentional. I can find other references to fill RHUI content addresses including two content substrings. For example, https://access.redhat.com/solutions/5079081 and https://access.redhat.com/articles/6972161.

ianballou
ianballou previously approved these changes Apr 7, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ianballou ianballou left a comment

Choose a reason for hiding this comment

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

Technical SME ACK for the ACS content 👍

@ianballou ianballou dismissed their stale review April 7, 2026 15:54

Missed the question above.

ianballou
ianballou approved these changes Apr 7, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@ianballou ianballou left a comment

Choose a reason for hiding this comment

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

Green tech ACK again after I've replied to the comment above.

@Lennonka Lennonka added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels Apr 7, 2026
@maximiliankolb maximiliankolb self-requested a review April 8, 2026 08:30
maximiliankolb
maximiliankolb approved these changes Apr 8, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

LGTM

guides/common/modules/proc_creating-an-rhui-alternate-content-source-by-using-web-ui.adoc
[role="_abstract"]
You can use RHUI alternate content sources to configure your {SmartProxy} to sync content from a Red{nbsp}Hat Update Infrastructure server.
You can create an RHUI alternate content source (ACS) to synchronize content from your Red{nbsp}Hat Update Infrastructure (RHUI) server.
Leverage your existing RHUI investment and accelerate content synchronization.
Copy link
Copy Markdown
Contributor

@maximiliankolb maximiliankolb Apr 8, 2026

Choose a reason for hiding this comment

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

This feels MARKETING-y. 🙃

non-blocking.

@maximiliankolb maximiliankolb 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maximiliankolb maximiliankolb maximiliankolb approved these changes

@ianballou ianballou ianballou approved these changes

Assignees

No one assigned

Labels

style review done No issues from docs style/grammar perspective tech review done No issues from the technical perspective

Projects

None yet

Milestone

Prepare for DITA migration (RH)

Development

Successfully merging this pull request may close these issues.

3 participants

@Lennonka @maximiliankolb @ianballou