Pluralize content view to view(s) #3801

bangelic · 2025-04-23T19:50:37Z

What changes are you introducing?

Adding (s) to content view to say content view(s).

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

Link to doc bug Jira: https://issues.redhat.com/browse/SAT-33205

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.14/Katello 4.16
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; 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)
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.

github-actions · 2025-04-23T19:54:01Z

The PR preview for a24294c is available at theforeman-foreman-documentation-preview-pr-3801.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

jeremylenz

Clarifying what's needed here. Comments below, but there probably will be more changes needed.

guides/common/modules/con_restricting-hosts-access-to-content.adoc

guides/common/modules/proc_changing-the-repository-sets-status-for-a-host-in-project.adoc

guides/common/modules/proc_installing-packages-on-a-host.adoc

guides/common/modules/proc_using-activation-keys-for-host-registration.adoc

guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc

guides/common/modules/ref_best-practices-for-errata.adoc

jeremylenz · 2025-04-23T20:50:56Z

Found some more places that need updating:

jeremylenz · 2025-04-23T20:51:22Z

These two are more than just simple word changes:

^ Here we should add a section right before 'Composite content views' about multiple content view environments. Something like "Assign hosts to multiple content view environments to give them access to content from more than one content view."

Here, we should mention MultiCV, e.g, add at the end "Or, assign hosts to multiple content view environments instead."

jeremylenz · 2025-04-23T20:54:34Z

This sentence needs a rewrite. It's tricky because hostgroups don't support multiCV yet, but AKs do.

When the host is registered, the content view environment(s) from the activation key overwrite the original content view from the host group or host settings. Then Foreman uses the content view environment(s) from the activation key for every future task, for example, rebuilding a host.

guides/common/modules/con_restricting-hosts-access-to-content.adoc

guides/common/modules/proc_changing-the-repository-sets-status-for-a-host-in-project.adoc

guides/common/modules/proc_viewing-errata-by-applicable-and-installable.adoc

bangelic · 2025-04-24T19:42:12Z

@jeremylenz Upon further research, the IBM Style guide doesn't allow for using s in a parentheses as (s). IBM Style Guide has two options, either content view environments or one or more content view environments. I recommend we go with one or more content view environments. Your thoughts?

jeremylenz · 2025-04-24T19:44:45Z

IBM Style Guide has two options, either content view environments or one or more content view environments. I recommend we go with one or more content view environments. Your thoughts?

I think content view environments will suffice in most places. e.g. the host's assigned content view environments.

guides/common/modules/con_host-collections-overview.adoc

guides/common/modules/con_managing-activation-keys.adoc

guides/common/modules/con_restricting-hosts-access-to-content.adoc

guides/common/modules/proc_changing-the-repository-sets-status-for-a-host-in-project.adoc

guides/common/modules/proc_creating-an-activation-key.adoc

jeremylenz · 2025-04-30T16:53:44Z

guides/common/modules/ref_best-practices-for-content-views.adoc

@@ -4,7 +4,7 @@
 * Content views that bundle content, such as {client-os} and additional software like `Apache-2.4` or `PostgreSQL-16.2`, are easier to maintain.
 Content views that are too small require more maintenance.
 * If you require daily updated content, use the content view `Default Organization View`, which contains the latest synchronized content from all repositories and is available in the Library lifecycle environment.
-* Restrict composite content views to situations that require greater flexibility, for example, if you update one content view on a weekly basis and another content view on a monthly basis.
+* Restrict composite content views to situations that require greater flexibility, for example, if you update one content view weekly, another monthly, or assign hosts to multiple content view environments.


Assigning multiple content view environments is an alternative to using composite content views. It should be its own item.

Suggested change

* Restrict composite content views to situations that require greater flexibility, for example, if you update one content view weekly, another monthly, or assign hosts to multiple content view environments.

* To give hosts access to content from multiple content views, for example, if you update one content view on a weekly basis and another content view on a monthly basis, you have two options:

- Assign hosts to multiple content view environments. For more info see xxxxx

- Assign hosts to composite content views. For more info see xxxxx

We don't have a section on assigning composite content views to hosts. I can reference the concept module Comparison of content view environments and composite content views.

sounds good! 👍

guides/common/modules/ref_best-practices-for-patching-content-hosts.adoc

guides/common/modules/ref_best-practices-for-content-views.adoc

jeremylenz

I think that's it for my comments!

maximiliankolb

Thanks Brian. One tiny suggestion about nested lists, rest LGTM.

maximiliankolb · 2025-05-02T05:30:20Z

guides/common/modules/ref_best-practices-for-content-views.adoc

@@ -4,7 +4,11 @@
 * Content views that bundle content, such as {client-os} and additional software like `Apache-2.4` or `PostgreSQL-16.2`, are easier to maintain.
 Content views that are too small require more maintenance.
 * If you require daily updated content, use the content view `Default Organization View`, which contains the latest synchronized content from all repositories and is available in the Library lifecycle environment.
-* Restrict composite content views to situations that require greater flexibility, for example, if you update one content view on a weekly basis and another content view on a monthly basis.
+* To give hosts access to content from multiple content views, such as when you update one content view weekly and another monthly, you have two options:
+- Assign multiple content view environments to hosts. 


Suggested change

- Assign multiple content view environments to hosts.

** Assign multiple content view environments to hosts.

maximiliankolb · 2025-05-02T05:30:28Z

guides/common/modules/ref_best-practices-for-content-views.adoc

+* To give hosts access to content from multiple content views, such as when you update one content view weekly and another monthly, you have two options:
+- Assign multiple content view environments to hosts. 
+For more information, see xref:assigning-content-view-environments-to-hosts[].
+- Assign composite content views to hosts. 


Suggested change

- Assign composite content views to hosts.

** Assign composite content views to hosts.

Lennonka

Just one thing. The rest looks good. Also, please, address Maximilian's comments.

Lennonka · 2025-05-05T12:10:58Z

guides/common/modules/con_restricting-hosts-access-to-content.adoc

@@ -35,6 +35,10 @@ For more information about adding content overrides to hosts, see {ManagingHosts
 +
 For more information about adding content overrides to activation keys, see xref:enabling-and-disabling-repositories-on-activation-key_{context}[].

+Multiple content view environments::


Suggested change

Multiple content view environments::

Content view environments::

This should suffice.

pr-processor bot added the Not yet reviewed label Apr 23, 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 Apr 23, 2025

jeremylenz suggested changes Apr 23, 2025

View reviewed changes

pr-processor bot added Waiting on contributor Requires an action from the author Needs re-review and removed Not yet reviewed Waiting on contributor Requires an action from the author labels Apr 23, 2025

jeremylenz suggested changes Apr 23, 2025

View reviewed changes

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

bangelic force-pushed the bangelic-SAT-33205-Docs-still-reference-single-content-view-and-lifecycle-view-environments branch from 1afd7ff to c1318b6 Compare April 29, 2025 19:47

jeremylenz reviewed Apr 30, 2025

View reviewed changes

pr-processor bot removed the Needs re-review label Apr 30, 2025

bangelic added 5 commits April 30, 2025 16:07

Pluralize content view to view(s)

046e041

Address suggestions to properly pluralize the correct term

9f31ec7

Address other areas of docs that need change

de4b546

Change pluralization to fit style guide

f7b46a6

Address suggestions

5f42723

bangelic force-pushed the bangelic-SAT-33205-Docs-still-reference-single-content-view-and-lifecycle-view-environments branch from c1318b6 to 5f42723 Compare April 30, 2025 20:07

Add xref to composite content view to hosts

0946677

Change to content view environments

451bcad

jeremylenz reviewed Apr 30, 2025

View reviewed changes

guides/common/modules/ref_best-practices-for-content-views.adoc Outdated Show resolved Hide resolved

Change to content views

a24294c

jeremylenz approved these changes Apr 30, 2025

View reviewed changes

maximiliankolb added tech review done No issues from the technical perspective and removed Needs tech review Requires a review from the technical perspective labels May 2, 2025

maximiliankolb reviewed May 2, 2025

View reviewed changes

Lennonka requested changes May 5, 2025

View reviewed changes

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pluralize content view to view(s) #3801

Pluralize content view to view(s) #3801

bangelic commented Apr 23, 2025

github-actions bot commented Apr 23, 2025 •

edited

Loading

jeremylenz left a comment

jeremylenz commented Apr 23, 2025 •

edited

Loading

jeremylenz commented Apr 23, 2025

jeremylenz commented Apr 23, 2025

bangelic commented Apr 24, 2025

jeremylenz commented Apr 24, 2025

jeremylenz Apr 30, 2025

bangelic Apr 30, 2025

jeremylenz Apr 30, 2025

jeremylenz left a comment

maximiliankolb left a comment

maximiliankolb May 2, 2025

maximiliankolb May 2, 2025

Lennonka left a comment

Lennonka May 5, 2025

-* Restrict composite content views to situations that require greater flexibility, for example, if you update one content view weekly, another monthly, or assign hosts to multiple content view environments.
+* To give hosts access to content from multiple content views, for example, if you update one content view on a weekly basis and another content view on a monthly basis, you have two options:
+- Assign hosts to multiple content view environments. For more info see xxxxx
+- Assign hosts to composite content views. For more info see xxxxx

	- Assign multiple content view environments to hosts.
	** Assign multiple content view environments to hosts.

	- Assign composite content views to hosts.
	** Assign composite content views to hosts.

	Multiple content view environments::
	Content view environments::

Pluralize content view to view(s) #3801

Are you sure you want to change the base?

Pluralize content view to view(s) #3801

Conversation

bangelic commented Apr 23, 2025

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

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

jeremylenz left a comment

Choose a reason for hiding this comment

jeremylenz commented Apr 23, 2025 • edited Loading

jeremylenz commented Apr 23, 2025

jeremylenz commented Apr 23, 2025

bangelic commented Apr 24, 2025

jeremylenz commented Apr 24, 2025

jeremylenz Apr 30, 2025

Choose a reason for hiding this comment

bangelic Apr 30, 2025

Choose a reason for hiding this comment

jeremylenz Apr 30, 2025

Choose a reason for hiding this comment

jeremylenz left a comment

Choose a reason for hiding this comment

maximiliankolb left a comment

Choose a reason for hiding this comment

maximiliankolb May 2, 2025

Choose a reason for hiding this comment

maximiliankolb May 2, 2025

Choose a reason for hiding this comment

Lennonka left a comment

Choose a reason for hiding this comment

Lennonka May 5, 2025

Choose a reason for hiding this comment

github-actions bot commented Apr 23, 2025 •

edited

Loading

jeremylenz commented Apr 23, 2025 •

edited

Loading