Skip to content

Conversation

@Lennonka
Copy link
Contributor

What changes are you introducing?

Adding [role="_abstract"] to modules in the Managing content guide

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

DITA compliance

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

  • I'm sorry this PR is so big! But at least it's focused :)

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.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
  • 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)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • We do not accept PRs for Foreman older than 3.9.

@Lennonka Lennonka marked this pull request as draft October 22, 2025 02:55
@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 Oct 22, 2025
@Lennonka Lennonka removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Oct 22, 2025
@maximiliankolb maximiliankolb self-requested a review October 22, 2025 06:54
Copy link
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.

111/217

[id="Configuring_Custom_Alternate_Content_Sources_{context}"]
= Configuring custom alternate content sources

[role="_abstract"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks wrong to me.

[id="Configuring_RHUI_Alternate_Content_Sources_{context}"]
= Configuring RHUI alternate content sources

[role="_abstract"]
Copy link
Contributor

Choose a reason for hiding this comment

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

same.

[id="Configuring_Simplified_Alternate_Content_Sources_{context}"]
= Configuring simplified alternate content sources

[role="_abstract"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Lacks an abstract.

How about

You can configure simplified alternate content sources (ACS) to download packages on {SmartProxyServers} from the upstream source.
Metadata will always come from your {ProjectServer}.

[role="_abstract"]
Use the following procedure to create an activation key that you can use to subscribe your hosts to content managed by {Project}.

. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Activation Keys*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Activation Keys*.
.Procedure
. In the {ProjectWebUI}, navigate to *Content* > *Lifecycle* > *Activation Keys*.

out of scope but I couldn't help myself.

Copy link
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.

201/217

[id="Importing_Syncable_Exports_{context}"]
= Importing syncable exports

[role="_abstract"]
Copy link
Contributor

Choose a reason for hiding this comment

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

This module lacks an abstract.

[role="_abstract"]
You can remove all content view environments from an activation key by doing either of the following:

.CLI procedure
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
.CLI procedure
.Procedure

Could also be out of scope. Your call.

@Lennonka
Copy link
Contributor Author

@maximiliankolb I truly appreciate the effort, but this PR is in draft for a reason and as such not ready for review.

@Lennonka
Copy link
Contributor Author

I think it will be better if I go chapter by chapter.

@Lennonka Lennonka closed this Oct 27, 2025
@Lennonka Lennonka deleted the comply-dita-mng-content-role-abstract branch October 27, 2025 12:19
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants