Comply with DITA - Mng content - CVs #4552

Lennonka · 2025-12-18T01:44:03Z

What changes are you introducing?

DITA-fying the Managing content views chapter 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.)

Abstracts will be reviewed later.
I've simplified some things.

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)
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)
We do not accept PRs for Foreman older than 3.12.

github-actions · 2025-12-18T01:47:52Z

The PR preview for 2524b32 is available at theforeman-foreman-documentation-preview-pr-4552.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

maximiliankolb

35/44

maximiliankolb · 2025-12-18T13:48:46Z

guides/common/modules/proc_viewing-module-streams-by-using-web-ui.adoc

+. In the {ProjectWebUI}, navigate to a published version of a *Content View* > *Module Streams* to view the module streams that are available for the Content Types.
+. Use the *Search* field to search for specific modules.
+. To view the information about the module, click the module and its corresponding tabs to include *Details*, *Repositories*, *Profiles*, and *Artifacts*.
+


Suggested change

maximiliankolb · 2025-12-18T14:24:15Z

guides/common/modules/proc_viewing-module-streams-by-using-cli.adoc

+$ hammer module-stream list \
+--organization-id _My_Organization_ID_
+----
+


Suggested change

maximiliankolb · 2025-12-18T14:25:16Z

guides/common/modules/proc_providing-the-salt-client-to-salt-minions.adoc

 For more information, see {ContentManagementDocURL}repository-synchronization[Repository synchronization].
 . Create a content view for each repository.
-For more information, see {ContentManagementDocURL}Creating_a_Content_View_content-management[Creating a content view].
+For more information, see {ContentManagementDocURL}creating-a-content-view-by-using-web-ui[Creating a content view].


Suggested change

For more information, see {ContentManagementDocURL}creating-a-content-view-by-using-web-ui[Creating a content view].

For more information, see {ContentManagementDocURL}creating-a-content-view-by-using-web-ui[Creating a content view by using {ProjectWebUI}].

same applies to line 34 and 38.

maximiliankolb · 2025-12-19T09:40:13Z

...modules/proc_assigning-a-rolling-content-view-to-lifecycle-environments-by-using-web-ui.adoc

+= Assigning a rolling content view to lifecycle environments by using {ProjectWebUI}
+
+[role="_abstract"]
+You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers} by using the {ProjectWebUI}.


Suggested change

You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers} by using the {ProjectWebUI}.

You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers} by using {ProjectWebUI}.

maximiliankolb · 2025-12-19T09:41:48Z

guides/common/modules/proc_copying-a-content-view-by-using-web-ui.adoc

-You can copy an existing content view into a new content view.
-To use the CLI instead of the {ProjectWebUI}, see the xref:cli-copying-a-content-view_{context}[].
+[role="_abstract"]
+You can copy an existing content view into a new content view by using the {ProjectWebUI}.


Suggested change

You can copy an existing content view into a new content view by using the {ProjectWebUI}.

You can copy an existing content view into a new content view by using {ProjectWebUI}.

maximiliankolb · 2025-12-19T09:42:30Z

guides/common/modules/proc_creating-a-composite-content-view-by-using-web-ui.adoc

+= Creating a composite content view by using {ProjectWebUI}
+
+[role="_abstract"]
+Use this procedure to create a composite content view by using the {ProjectWebUI}.


Suggested change

Use this procedure to create a composite content view by using the {ProjectWebUI}.

Use this procedure to create a composite content view by using {ProjectWebUI}.

maximiliankolb · 2025-12-19T09:42:53Z

guides/common/modules/proc_creating-a-content-view-by-using-cli.adoc

+= Creating a content view by using Hammer CLI
+
+[role="_abstract"]
+Use this procedure to create a simple content view by using Hammer CLI.


Suggested change

Use this procedure to create a simple content view by using Hammer CLI.

Use this procedure to create a content view by using Hammer CLI.

maximiliankolb · 2025-12-19T09:43:36Z

guides/common/modules/proc_creating-a-content-view-by-using-cli.adoc

+--description "_My_Content_View_" \
+--name "_My_Content_View_" \
+--organization "_My_Organization_" \
+--repository-ids 1,2


Suggested change

--repository-ids 1,2

--repository-ids _My_Repository_ID_1_,_My_Repository_ID_2_

maximiliankolb · 2025-12-19T10:11:24Z

guides/common/modules/proc_creating-a-content-view-by-using-web-ui.adoc

+= Creating a content view by using {ProjectWebUI}
+
+[role="_abstract"]
+Use this procedure to create a simple content view by using the {ProjectWebUI}.


Suggested change

Use this procedure to create a simple content view by using the {ProjectWebUI}.

Use this procedure to create a content view by using the {ProjectWebUI}.

maximiliankolb

44/44. Overall LGTM; I made some more minor suggestions. Please rebase to HEAD of "master".

maximiliankolb · 2025-12-19T12:40:01Z

guides/common/modules/proc_creating-a-rolling-content-view-by-using-web-ui.adoc

-You can create a rolling content view in the {ProjectWebUI}.
-To use the CLI instead of the {ProjectWebUI}, see the xref:cli-creating-a-rolling-content-view[].
+[role="_abstract"]
+You can create a rolling content view by using the {ProjectWebUI}.


Suggested change

You can create a rolling content view by using the {ProjectWebUI}.

You can create a rolling content view by using {ProjectWebUI}.

maximiliankolb · 2025-12-19T12:41:40Z

guides/common/modules/proc_promoting-a-content-view-by-using-web-ui.adoc

+= Promoting a content view by using {ProjectWebUI}
+
+[role="_abstract"]
+Use this procedure to promote content views across different lifecycle environments by using the {ProjectWebUI}.


Suggested change

Use this procedure to promote content views across different lifecycle environments by using the {ProjectWebUI}.

Use this procedure to promote content views across different lifecycle environments by using {ProjectWebUI}.

maximiliankolb · 2025-12-19T12:43:00Z

guides/common/modules/proc_viewing-module-streams-by-using-web-ui.adoc

+= Viewing module streams by using {ProjectWebUI}
+
+[role="_abstract"]
+In {Project}, you can view the module streams of the repositories in your content views by using the {ProjectWebUI}.


Suggested change

In {Project}, you can view the module streams of the repositories in your content views by using the {ProjectWebUI}.

In {Project}, you can view the module streams of the repositories in your content views by using {ProjectWebUI}.

Maybe also:

Suggested change

In {Project}, you can view the module streams of the repositories in your content views by using the {ProjectWebUI}.

You can view the module streams of the repositories in your content views by using {ProjectWebUI}.

maximiliankolb · 2025-12-19T12:49:28Z

guides/common/modules/proc_viewing-module-streams-by-using-web-ui.adoc

+In {Project}, you can view the module streams of the repositories in your content views by using the {ProjectWebUI}.
+
+.Procedure
+. In the {ProjectWebUI}, navigate to a published version of a *Content View* > *Module Streams* to view the module streams that are available for the Content Types.


Suggested change

. In the {ProjectWebUI}, navigate to a published version of a *Content View* > *Module Streams* to view the module streams that are available for the Content Types.

. In the {ProjectWebUI}, *Content* > *Lifecycle* > *Content Views*.

. Select your content view.

. Click on a published version.

. Click *Module Streams* to view the module streams that are available for the Content Types.

I could not reproduce line 10, so I created this suggestions on how to view module streams of CVs.

Lennonka added 4 commits December 18, 2025 02:24

Add role abstract

6c3a29b

Split web UI and CLI procedures

b2f1192

Formalize examples

3dde070

Replace block titles with dlist

9cbb288

pr-processor bot added the Not yet reviewed label Dec 18, 2025

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 Dec 18, 2025

Lennonka removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Dec 18, 2025

Lennonka added 7 commits December 18, 2025 02:56

fixup! Replace block titles with dlist

ddbbcda

Replace block titles with dlist

22a33e6

Split web UI and CLI procedures

fd79299

Split web UI and CLI procedures

d30330f

Split web UI and CLI procedures

d03fbaa

Split web UI and CLI procedures

6733b3e

Split web UI and CLI procedures

c954f08

Lennonka added this to the Prepare for DITA migration (RH) milestone Dec 18, 2025

Lennonka added 3 commits December 18, 2025 05:07

Split procedures

8d37763

Fix procedure

83dbd19

Fix concept

2524b32

Lennonka marked this pull request as ready for review December 18, 2025 04:28

maximiliankolb reviewed Dec 19, 2025

View reviewed changes

pr-processor bot removed the Not yet reviewed label Dec 19, 2025

maximiliankolb requested changes Dec 19, 2025

View reviewed changes

pr-processor bot added the Waiting on contributor Requires an action from the author label Dec 19, 2025

	For more information, see {ContentManagementDocURL}creating-a-content-view-by-using-web-ui[Creating a content view].
	For more information, see {ContentManagementDocURL}creating-a-content-view-by-using-web-ui[Creating a content view by using {ProjectWebUI}].

	You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers} by using the {ProjectWebUI}.
	You can assign your rolling content view to lifecycle environments to limit Library content synchronized to {SmartProxyServers} by using {ProjectWebUI}.

	You can copy an existing content view into a new content view by using the {ProjectWebUI}.
	You can copy an existing content view into a new content view by using {ProjectWebUI}.

	Use this procedure to create a composite content view by using the {ProjectWebUI}.
	Use this procedure to create a composite content view by using {ProjectWebUI}.

	Use this procedure to create a simple content view by using Hammer CLI.
	Use this procedure to create a content view by using Hammer CLI.

	--repository-ids 1,2
	--repository-ids _My_Repository_ID_1_,_My_Repository_ID_2_

	You can create a rolling content view by using the {ProjectWebUI}.
	You can create a rolling content view by using {ProjectWebUI}.

	Use this procedure to promote content views across different lifecycle environments by using the {ProjectWebUI}.
	Use this procedure to promote content views across different lifecycle environments by using {ProjectWebUI}.

	In {Project}, you can view the module streams of the repositories in your content views by using the {ProjectWebUI}.
	In {Project}, you can view the module streams of the repositories in your content views by using {ProjectWebUI}.

	In {Project}, you can view the module streams of the repositories in your content views by using the {ProjectWebUI}.
	You can view the module streams of the repositories in your content views by using {ProjectWebUI}.

-. In the {ProjectWebUI}, navigate to a published version of a *Content View* > *Module Streams* to view the module streams that are available for the Content Types.
+. In the {ProjectWebUI}, *Content* > *Lifecycle* > *Content Views*.
+. Select your content view.
+. Click on a published version.
+. Click *Module Streams* to view the module streams that are available for the Content Types.

Comply with DITA - Mng content - CVs #4552

Are you sure you want to change the base?

Comply with DITA - Mng content - CVs #4552

Uh oh!

Conversation

Lennonka commented Dec 18, 2025 • 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 Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maximiliankolb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

maximiliankolb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Lennonka commented Dec 18, 2025 •

edited

Loading

github-actions bot commented Dec 18, 2025 •

edited

Loading