Rework planning for foreman #3634
Conversation
github-actions
bot
added
Needs tech review
maximiliankolb
force-pushed
the
rework_planning_for_foreman
branch
4 times, most recently
from
ddf71b1 to
b43f81f
Compare
* Add images for upstream $ git diff master| rg "image::" | rg -v "^@@" | rg -v -- "^-" | cut -c 2- | sed "s@image::common/@guides/common/images/@g" | sed "s/\[.*$//g" * Add xref for ULN content * Hide content for foreman-el+deb * Make images not executable $ chmod -x guides/common/images/* * Render Planning for Foreman for all flavours $ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "assembly_" * Reword "on the other hand" to make Vale happy * Reword concepts included in Planning guide $ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "modules/" * Split file * Use assembly to bundle provisioning requirements * Verify content in Planning guide for all flavours $ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "assembly_" | xargs -I {} cat "{}" | rg "^include" | sed "s/include::/guides\/common\//g" | sed "s/\[.*$//g"
maximiliankolb
force-pushed
the
rework_planning_for_foreman
branch
from
f331cd7 to
4492d57
Compare
| @@ -6,7 +6,7 @@ ifdef::satellite[] | |||
| You can use Red{nbsp}Hat content as well as custom content and organize it into {Project} products. | |||
| endif::[] | |||
| ifdef::katello,orcharhino[] | |||
| You can use content from Red{nbsp}Hat as well as from Canonical, Oracle, SUSE, and other custom content. | |||
| You can use any custom content and content from Red{nbsp}Hat, Canonical, Oracle, and SUSE. | |||
There was a problem hiding this comment.
Note: I have added these because there's special docs/instructions on how to consume their content:
- Red Hat: -> RH manifest
- Canonical: -> ESM
- Oracle: -> ULN repositories
- SUSE: -> SCC Manager
This is all part of Foreman+Katello docs.
Do you think it's missing a sentence about OS vendor content such as Debian or Rocky Linux? Or maybe refer users to the list of supported Client OS for which default upstream content is always supported?
There was a problem hiding this comment.
Adding this is okay. I'm not sure if it's necessary to mention other content specifically. But it might be worth letting users know.
| ifdef::satellite[] | ||
| include::common/modules/proc_providing-feedback-on-red-hat-documentation.adoc[leveloffset=+1] | ||
| endif::[] | ||
|
|
||
| include::common/modules/con_foreman-overview-and-concepts.adoc[] | ||
|
|
||
| ifdef::katello,satellite,orcharhino[] |
There was a problem hiding this comment.
Missing endif below Content and patch management?
There's not much in the foreman-el build right now :)
There was a problem hiding this comment.
There's a leftover something on the left.
There was a problem hiding this comment.
"Foreman Server & Smart Proxy Servers" -- Foreman Server is not involved, it's only "Smart Proxy servers".
(You might have thought that because Satellite sometimes used to call Capsules "Red Hat Satellite Capsules", but that doesn't mean there's Satellite Server, it's just a silly marketing name leftover.)
There was a problem hiding this comment.
"Foreman Server & Smart Proxy Servers" -- Foreman Server is not involved, it's only "Smart Proxy servers".
| @@ -6,7 +6,7 @@ ifdef::satellite[] | |||
| You can use Red{nbsp}Hat content as well as custom content and organize it into {Project} products. | |||
| endif::[] | |||
| ifdef::katello,orcharhino[] | |||
| You can use content from Red{nbsp}Hat as well as from Canonical, Oracle, SUSE, and other custom content. | |||
| You can use any custom content and content from Red{nbsp}Hat, Canonical, Oracle, and SUSE. | |||
There was a problem hiding this comment.
Adding this is okay. I'm not sure if it's necessary to mention other content specifically. But it might be worth letting users know.
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.)
guides/common/images/topology-direct-satellite.pngguides/common/images/topology-isolated-satellite.pngguides/common/modules/con_creating-and-managing-roles.adoc->guides/common/modules/snip_creating-and-managing-roles.adocwhich is now included in twocon_filesguides/common/modules/ref_overview-of-authentication-methods-in-project.adoc->guides/common/modules/snip_table-authentication-methods.adocwhich is also included in twocon_filesTODO
cp && sed🤞Checklists
no cherry-picks