Combine insights modules into one procedure module by AkshayGadhaveRH · Pull Request #3933 · theforeman/foreman-documentation

AkshayGadhaveRH · 2025-06-12T06:36:19Z

Currently there are two separate insights modules under the Performing additional configuration on Satellite Server section:

Using Red Hat Insights with Satellite Server
Disabling Red Hat Insights registration

These two can be combined under a single header Managing Insights. There are common commands listed in these two modules, and these can be listed as bullet points in a reference module rather than a procedure module.

JIRA: https://issues.redhat.com/browse/SAT-28621

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.)

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.15/Katello 4.17
Foreman 3.14/Katello 4.16 (Satellite 6.17)
Foreman 3.13/Katello 4.15 (EL9 only)
Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only)
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.

github-actions · 2025-06-12T06:39:37Z

The PR preview for 3012099 is available at theforeman-foreman-documentation-preview-pr-3933.surge.sh

The following output files are affected by this PR:

Installing_Server/index-satellite.html

show diff

show diff as HTML

aneta-petrova · 2025-06-12T08:31:48Z

Hi @AkshayGadhaveRH, the issue with how we document integration with Insights runs a bit deeper now and #3910 is there to address it. I'm not sure what to do and you are free to continue with your PR, just note that if my PR ends up being merged, I might end up overwriting your changes again.

AkshayGadhaveRH · 2025-06-12T08:51:55Z

Hey @aneta-petrova I think your PR addresses a lot of issues with the insights modules. However, I feel we can still combine the two modules, once your changes are merged.
The two concept modules (Overview of {Project} integration with Insights and Using Red{nbsp}Hat Insights with {Project}) look really neat.
Maybe I can take a call once your PR is merged?

aneta-petrova · 2025-06-12T09:00:32Z

Okay, Akshay! :) I'll do my best to get my PR done as quickly as possible so that I can unblock you on this.

aneta-petrova

I'm aware that some of the suggestions affect content you didn't author yourself but I hope that's okay because I see this as an opportunity to make sure the procedure complies with the mod docs template.

Lennonka

According to the Modular documentation reference, custom discrete headings are not allowed in procedure modules.

For the purpose of DITA migration, we have to be strict about the structure of modules.

Let's not introduce custom headings or make this module into an actual reference module. See also Reference modules in the modularization docs.

Lennonka

A couple of suggestions

- Change the Insights module back to a reference module. - Restructure the content. - Remove redundant information about preinstalled package.

- Removed the custom discrete headings. - Reinstated the `Procedure` heading. - Removed the unregister step and added a link to the `Configuring Insights Client` section under Additional Resources.

Lennonka

Nitpicks. The rest looks good!

AkshayGadhaveRH · 2025-07-23T14:03:39Z

@Lennonka do you think this needs a tech review, since this is just a docs change?

Lennonka · 2025-07-23T14:24:37Z

Tech review not necessary. Thanks!

Lennonka · 2025-07-23T14:27:03Z

Not cherry picked - there are conflicts on 3.15. cc @AkshayGadhaveRH

pr-processor Bot added the Not yet reviewed label Jun 12, 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 Jun 12, 2025

maximiliankolb reviewed Jun 12, 2025

View reviewed changes

Comment thread guides/common/modules/ref_managing-red-hat-insights.adoc Outdated

Comment thread guides/common/modules/ref_managing-red-hat-insights.adoc Outdated

pr-processor Bot removed the Not yet reviewed label Jun 12, 2025

Lennonka added the Waiting on contributor Requires an action from the author label Jun 23, 2025

AkshayGadhaveRH force-pushed the consolidate_managing_insights_modules branch from b183471 to 64e716b Compare July 3, 2025 06:42

pr-processor Bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Jul 3, 2025

aneta-petrova reviewed Jul 3, 2025

View reviewed changes

pr-processor Bot removed the Needs re-review label Jul 3, 2025

AkshayGadhaveRH force-pushed the consolidate_managing_insights_modules branch from 64e716b to b878371 Compare July 7, 2025 12:30

Lennonka requested changes Jul 14, 2025

View reviewed changes

pr-processor Bot added the Waiting on contributor Requires an action from the author label Jul 14, 2025

AkshayGadhaveRH force-pushed the consolidate_managing_insights_modules branch from c65f1eb to 1ab89ed Compare July 15, 2025 07:21

pr-processor Bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Jul 15, 2025

maximiliankolb reviewed Jul 15, 2025

View reviewed changes

Comment thread guides/common/modules/proc_configuring-project-server-as-red-hat-insights-client.adoc Outdated

pr-processor Bot removed the Needs re-review label Jul 15, 2025

AkshayGadhaveRH force-pushed the consolidate_managing_insights_modules branch 2 times, most recently from bac6e70 to 501383a Compare July 16, 2025 12:28

Lennonka requested changes Jul 16, 2025

View reviewed changes

Comment thread guides/common/modules/proc_configuring-project-server-as-red-hat-insights-client.adoc Outdated

Comment thread guides/common/modules/proc_configuring-project-server-as-red-hat-insights-client.adoc Outdated

pr-processor Bot added the Waiting on contributor Requires an action from the author label Jul 16, 2025

AkshayGadhaveRH force-pushed the consolidate_managing_insights_modules branch from 501383a to 4ddc3b5 Compare July 17, 2025 05:49

pr-processor Bot added the Needs re-review label Jul 17, 2025

Akshay Gadhave added 16 commits July 23, 2025 15:47

Apply changes suggested in PR

5b6b28e

- Change the Insights module back to a reference module. - Restructure the content. - Remove redundant information about preinstalled package.

Remove context from the ID

d913c09

Apply changes suggested in the PR

1ee21a3

- Removed the custom discrete headings. - Reinstated the `Procedure` heading. - Removed the unregister step and added a link to the `Configuring Insights Client` section under Additional Resources.

Remove blank space on line 23

8a738ae

Remove text in additional resources

6dbdaf8

Fix links and add step to unregister

8828483

Move unregistration to next steps

3ff67c6

Rename module

7e0d4f7

Remove unused module disabling-insights-registration

42743e4

Replace Red Hat Insights with the Insights attribute

6a125ee

Apply changes suggested in the PR

eb0f577

Apply change suggested in PR

9cf825d

Apply change suggested in PR

4fbb971

Apply changes suggested in the PR

cd06157

Move links to additional resources

a479cce

Add verification section

ea89c77

AkshayGadhaveRH force-pushed the consolidate_managing_insights_modules branch from 23907af to ea89c77 Compare July 23, 2025 10:21

pr-processor Bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Jul 23, 2025

AkshayGadhaveRH removed the Needs testing Requires functional testing label Jul 23, 2025

Lennonka approved these changes Jul 23, 2025

View reviewed changes

Comment thread guides/common/modules/proc_configuring-project-server-as-insights-client.adoc Outdated

Comment thread guides/common/modules/proc_configuring-project-server-as-insights-client.adoc Outdated

pr-processor Bot removed the Needs re-review label Jul 23, 2025

Apply changes suggested in the PR

3012099

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 Jul 23, 2025

Lennonka removed the Needs tech review Requires a review from the technical perspective label Jul 23, 2025

Lennonka merged commit 87fb643 into theforeman:master Jul 23, 2025
9 of 10 checks passed

Conversation

AkshayGadhaveRH commented Jun 12, 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.)

Checklists

Uh oh!

github-actions Bot commented Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aneta-petrova commented Jun 12, 2025

Uh oh!

AkshayGadhaveRH commented Jun 12, 2025

Uh oh!

aneta-petrova commented Jun 12, 2025

Uh oh!

Uh oh!

Uh oh!

aneta-petrova left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lennonka left a comment • 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!

Uh oh!

Lennonka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Lennonka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AkshayGadhaveRH commented Jul 23, 2025

Uh oh!

Lennonka commented Jul 23, 2025

Uh oh!

Uh oh!

Lennonka commented Jul 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

AkshayGadhaveRH commented Jun 12, 2025 •

edited

Loading

github-actions Bot commented Jun 12, 2025 •

edited

Loading

Lennonka left a comment •

edited

Loading