Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding new concepts and procedures for Multi CV hosts and AKs #3609

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Adding new concepts and procedures for Multi CV hosts and AKs #3609

wants to merge 7 commits into from

Conversation

bangelic
Copy link
Contributor

What changes are you introducing?

New procedures and concepts pertaining to
multiple content view environments for hosts
and activation keys related to https://issues.redhat.com/browse/SAT-20897

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

New features for 6.17.

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

A separate PR for the same ticket will be submitted
to update existing documentation.

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.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

@bangelic
Copy link
Contributor Author

@jeremylenz This PR is supposed to cover the new procedures and concepts from our shared Google Doc. Take a look and make suggestions and comments because we had a lot of content and I want to make sure nothing got overlooked. We can discuss the content needed for the existing documentation to be put in a separate PR. This is just the new procedures and concepts.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 23, 2025 •
edited
Loading

The PR preview for 1f7cc9d is available at theforeman-foreman-documentation-preview-pr-3609.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

jeremylenz
jeremylenz reviewed Jan 23, 2025
View reviewed changes
guides/common/modules/con_content-view-environment-ordering-and-priority.adoc Show resolved Hide resolved
...on_handling-content-view-environments-during-registration-with-multiple-activation-keys.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_assigning-content-view-environments-to-an-activation-key-by-ID.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_assigning-multiple-content-view-environments-to-activation-keys.adoc Outdated Show resolved Hide resolved
...es/proc_assigning-multiple-content-view-environments-to-hosts-with-subscription-manager.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_assigning-multiple-content-view-environments-to-hosts.adoc Outdated Show resolved Hide resolved
...dules/proc_removing-all-content-view-environments-from-an-activation-key-assigned-by-ID.adoc Outdated Show resolved Hide resolved
...dules/proc_removing-all-content-view-environments-from-an-activation-key-assigned-by-ID.adoc Outdated Show resolved Hide resolved
...dules/proc_removing-all-content-view-environments-from-an-activation-key-assigned-by-ID.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_removing-all-content-view-environments-from-an-activation-key.adoc Outdated Show resolved Hide resolved
@Lennonka Lennonka added the Waiting on contributor Requires an action from the author label Jan 29, 2025
@bangelic bangelic force-pushed the bangelic-SAT-20897-Update-docs-for-MultiCV-hosts-and-AKs-new-docs branch from 9d3fdfa to da5911b Compare January 30, 2025 01:33
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author labels Jan 30, 2025
@bangelic bangelic force-pushed the bangelic-SAT-20897-Update-docs-for-MultiCV-hosts-and-AKs-new-docs branch from da5911b to c8782e6 Compare January 30, 2025 19:37
@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 Jan 30, 2025
jeremylenz
jeremylenz reviewed Jan 31, 2025
View reviewed changes
guides/common/modules/proc_viewing-multiple-content-view-environment-activation-keys.adoc Outdated Show resolved Hide resolved
guides/common/modules/con_understanding-multiple-content-view-environments.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_assigning-multiple-content-view-environments-to-activation-keys.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_assigning-multiple-content-view-environments-to-activation-keys.adoc Outdated Show resolved Hide resolved
...es/proc_assigning-multiple-content-view-environments-to-hosts-with-subscription-manager.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_viewing-multiple-content-view-environment-hosts.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_viewing-multiple-content-view-environment-hosts.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_viewing-multiple-content-view-environment-hosts.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_viewing-multiple-content-view-environment-hosts.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_viewing-multiple-content-view-environment-hosts.adoc Outdated Show resolved Hide resolved
@bangelic bangelic force-pushed the bangelic-SAT-20897-Update-docs-for-MultiCV-hosts-and-AKs-new-docs branch from 4d92e7d to f00c1c4 Compare January 31, 2025 18:56
jeremylenz
jeremylenz reviewed Feb 3, 2025
View reviewed changes
guides/common/modules/con_understanding-multiple-content-view-environments.adoc Outdated Show resolved Hide resolved
guides/common/modules/con_understanding-multiple-content-view-environments.adoc Show resolved Hide resolved
guides/common/modules/proc_assigning-content-view-environments-to-an-activation-key-by-ID.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_assigning-multiple-content-view-environments-to-activation-keys.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_assigning-multiple-content-view-environments-to-hosts.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_viewing-multiple-content-view-environment-hosts.adoc Outdated Show resolved Hide resolved
guides/common/modules/proc_viewing-multiple-content-view-environment-hosts.adoc Outdated Show resolved Hide resolved
guides/common/modules/con_content-view-environment-categories.adoc Outdated Show resolved Hide resolved
guides/common/assembly_understanding-multiple-content-view-environments.adoc Outdated Show resolved Hide resolved
...on/modules/con_comparing-multiple-content-view-environments-and-composite-content-views.adoc Outdated Show resolved Hide resolved
@bangelic bangelic force-pushed the bangelic-SAT-20897-Update-docs-for-MultiCV-hosts-and-AKs-new-docs branch from f00c1c4 to ea226ec Compare February 3, 2025 22:04
@bangelic bangelic force-pushed the bangelic-SAT-20897-Update-docs-for-MultiCV-hosts-and-AKs-new-docs branch from ea226ec to 1f7cc9d Compare February 4, 2025 19:44
jeremylenz
jeremylenz approved these changes Feb 6, 2025
View reviewed changes
Copy link
Contributor

@jeremylenz jeremylenz left a comment

Choose a reason for hiding this comment

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

All my concerns are addressed, thanks @bangelic!

@aneta-petrova @apinnick any other comments?

apinnick
apinnick reviewed Feb 9, 2025
View reviewed changes
guides/common/assembly_understanding-multiple-content-view-environments.adoc
@@ -0,0 +1,23 @@
include::modules/con_understanding-multiple-content-view-environments.adoc[]
Copy link
Contributor

Choose a reason for hiding this comment

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

I recommend that you not use this module for the assembly title and intro. Most of the modules below are procedures, not concepts.

I recommend creating a concept module called "Managing multiple content views" with an overview of the assembly's contents. That title indicates the procedural content of this assembly and is consistent with the title of the preceding assembly, "Managing content views".

apinnick
apinnick reviewed Feb 9, 2025
View reviewed changes
guides/common/assembly_understanding-multiple-content-view-environments.adoc

include::modules/proc_viewing-multiple-content-view-environment-hosts.adoc[leveloffset=+1]

include::modules/proc_assigning-multiple-content-view-environments-to-activation-keys.adoc[leveloffset=+1]
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the AK modules would make more sense on the Managing AKs assembly and linked from this assembly. Alternatively, you could change the offset of the other AK modules to +2, so that they appear under this module.

With so many leveloffset=+1 headers, it's not easy to grasp the overall structure of this assembly. I think a user might find it difficult to figure out the order of the steps when faced with so many choices.

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd be +1 to increasing the level.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aneta-petrova aneta-petrova aneta-petrova left review comments

@jeremylenz jeremylenz jeremylenz approved these changes

@apinnick apinnick apinnick left review comments

Assignees
No one assigned
Labels
Needs style review Requires a review from docs style/grammar perspective Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bangelic @aneta-petrova @jeremylenz @apinnick @Lennonka