Rework planning for foreman #3634
Open
+1,328
−208
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Needs tech review
maximiliankolb
force-pushed
the
rework_planning_for_foreman
branch
5 times, most recently
from
f331cd7 to
4492d57
Compare
maximiliankolb
commented
Feb 6, 2025
Lennonka
reviewed
Feb 6, 2025
Comment on lines
43
to
45
| * For more information about basic workflows, see {ContentManagementDocURL}Basic_Content_Management_Workflow_content-management[Basic content management workflow]. | ||
| * For more information about Deb content, see {ContentManagementDocURL}Adding_Custom_Deb_Repositories_content-management[Adding Deb repositories] in _{ContentManagementDocTitle}_. | ||
| * For more information about Yum content, see {ContentManagementDocURL}Adding_Custom_RPM_Repositories_content-management[Adding RPM repositories] in _{ContentManagementDocTitle}_. |
There was a problem hiding this comment.
I prefer the original (shorter) list of references because I don't think that a link whose label says "Basic workflow" needs to be introduced with the words "basic workflows" :) And it's similar for the other links. But that's just FYI to explain why I wrote the original list of references the way it was before. This is your PR and your call, obviously :)
There was a problem hiding this comment.
I have removed "basic workflow" from the description.
| Lifecycle environment based structure:: | ||
| In this hierarchy, the first host group level is reserved for parameters specific to a lifecycle environment. | ||
| The second level contains operating system related definitions, and the third level contains application specific settings. | ||
| Such structure is useful in scenarios where responsibilities are divided among lifecycle environments (for example, a dedicated owner for the *Development*, *QA*, and *Production* lifecycle stages). | ||
| Such structure is useful in scenarios where responsibilities are divided among lifecycle environments, for example, a dedicated owner for the *Development*, *QA*, and *Production* lifecycle stages. |
There was a problem hiding this comment.
Is it just me or does this also look strange without the parentheses? Written this way, it looks like you're listing examples of lifecycle environments (nonsense, I know, but that's what it looks like when I read it as one sentence without the extra parenthesis separator). Would it make sense to split this into two sentences as well?
There was a problem hiding this comment.
Reworded. What do you think now?
guides/common/modules/con_provisioning-management-with-project-additional-resources.adoc
Show resolved
Hide resolved
9 tasks
maximiliankolb
force-pushed
the
rework_planning_for_foreman
branch
from
4492d57 to
5d9886a
Compare
maximiliankolb
commented
Feb 17, 2025
Comment on lines
43
to
45
| * For more information about basic workflows, see {ContentManagementDocURL}Basic_Content_Management_Workflow_content-management[Basic content management workflow]. | ||
| * For more information about Deb content, see {ContentManagementDocURL}Adding_Custom_Deb_Repositories_content-management[Adding Deb repositories] in _{ContentManagementDocTitle}_. | ||
| * For more information about Yum content, see {ContentManagementDocURL}Adding_Custom_RPM_Repositories_content-management[Adding RPM repositories] in _{ContentManagementDocTitle}_. |
There was a problem hiding this comment.
I have removed "basic workflow" from the description.
| Lifecycle environment based structure:: | ||
| In this hierarchy, the first host group level is reserved for parameters specific to a lifecycle environment. | ||
| The second level contains operating system related definitions, and the third level contains application specific settings. | ||
| Such structure is useful in scenarios where responsibilities are divided among lifecycle environments (for example, a dedicated owner for the *Development*, *QA*, and *Production* lifecycle stages). | ||
| Such structure is useful in scenarios where responsibilities are divided among lifecycle environments, for example, a dedicated owner for the *Development*, *QA*, and *Production* lifecycle stages. |
There was a problem hiding this comment.
Reworded. What do you think now?
guides/common/modules/con_provisioning-management-with-project-additional-resources.adoc
Show resolved
Hide resolved
aneta-petrova
approved these changes
Feb 17, 2025
aneta-petrova
added
style review done
maximiliankolb
force-pushed
the
rework_planning_for_foreman
branch
from
5d9886a to
15ad8c0
Compare
maximiliankolb
commented
Feb 17, 2025
* 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"
Export from draw.io with the following options: * zoom 100% * transparent no * appearance light * embed yes (2x)
This helps a lot: * You know where is original source is due to the file name of the graphics * When working on the original source file, you can easily export as SVG and just download to your local machine; then copy the graphic without renaming it.
maximiliankolb
force-pushed
the
rework_planning_for_foreman
branch
from
7301ff2 to
84df163
Compare
|
Rebased to HEAD of "master". |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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