Skip to content

Optimize (CQA) - Split Managing CVs per user story#4895

Open
Lennonka wants to merge 7 commits into
theforeman:masterfrom
Lennonka:premig-mng-content-CVs-stories
Open

Optimize (CQA) - Split Managing CVs per user story#4895
Lennonka wants to merge 7 commits into
theforeman:masterfrom
Lennonka:premig-mng-content-CVs-stories

Conversation

@Lennonka

@Lennonka Lennonka commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

What changes are you introducing?

Restructuring the Managing content views chapter in Managing content

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

  • The chapter was huge, so I've restructured it so that each section includes a single user story.

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

  • TOC nesting does not exceed 3 levels.
  • Using preview when reviewing the new structure is recommended.

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.19/Katello 4.21
  • 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, 7.7, and 7.8)
  • 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 Jun 2, 2026
@Lennonka Lennonka removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels Jun 2, 2026
@Lennonka Lennonka requested a review from jafiala June 2, 2026 22:39
Comment thread guides/common/assembly_managing-content-views-and-related-configuration.adoc Outdated

@maximiliankolb maximiliankolb left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I found one issue about CCVs (which also exists on "master"). Rest LGTM minus some nitpicks.

ifeval::["{context}" == "planning"]
.Additional resources
* {ContentManagementDocURL}Managing_Content_Views_content-management[Managing content views in _{ContentManagementDocTitle}_]
* {ContentManagementDocURL}managing-content-views-and-related-configuration[Managing content views in _{ContentManagementDocTitle}_]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please also adjust the title; applied to other files too.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

As soon as we agree on the title.

:_mod-docs-content-type: CONCEPT

[id="managing-content-views-and-related-configuration"]
= Managing content views and related configuration

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

non-blocking: I am a tiny bit unsure about the title. What do you think about

Suggested change
= Managing content views and related configuration
= Managing content views

Too short?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah, is it mainly because we already have guides/common/modules/con_managing-content-views.adoc?

@Lennonka Lennonka Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes, among other reasons. The assembly now includes CV Envs as well. I'm open to further suggestions for the umbrella title. My initial idea was Managing content views, filters, and versions. WDYT?

I'm also uncertain about including CV Envs in the same assembly.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Maybe "Managing content views and content view environments"? IMO filters and versions are just part of managing CVs.

As mentioned above, non-blocking from my side.

Comment thread guides/common/modules/con_using-composite-content-views.adoc Outdated
@Lennonka Lennonka force-pushed the premig-mng-content-CVs-stories branch from 898374a to 6c3b523 Compare June 3, 2026 23:11
@Lennonka

Lennonka commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

Rebased.

@Lennonka

Lennonka commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

@jafiala or @aneta-petrova Can one of you, please, review the new structure?

@jafiala jafiala left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like it. When you agree on the name, it should be good to go. I don't have a preference in the name, all options seem reasonable to me.

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.

4 participants