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

Rework planning for foreman #3634

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from
Draft

Rework planning for foreman #3634

wants to merge 4 commits into from

Conversation

maximiliankolb
Copy link
Contributor

@maximiliankolb maximiliankolb commented Jan 31, 2025 •
edited
Loading

What changes are you introducing?

  • Rework "Planning for Foreman" guide to make it fit for all flavours

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

  • show it upstream for all flavours
  • make content fit for orcharhino

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

  • Requires Remove unnecessary macros #3632
  • Style-wise, I will try to apply all your feedback.
  • The guide is big: I might create issues for existing technical inaccuracies rather than fixing/retesting everything myself.
  • TODO: "guides/common/modules/con_content-types-in-project.adoc" and later

Checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

no cherry-picks

@maximiliankolb
Use assembly to bundle provisioning requirements
ff26ca8
@maximiliankolb
Reword concepts included in Planning guide
ae29b66 
$ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "modules/"
@maximiliankolb
Render Planning for Foreman for all flavours
5434905 
$ cat guides/doc-Planning_for_Project/master.adoc | rg "^include" | sed "s/include::/guides\//g" | sed "s/\[.*$//g" | rg "assembly_"

TODO: get changes for
"guides/common/assembly_supported-usage-and-versions-of-project-components.adoc"
from another upstream PR
@maximiliankolb
Make Planning guide fit for all flavours
297eb4d 
$ 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"
@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 31, 2025
@github-actions GitHub Actions
Copy link

The PR preview for 297eb4d is available at theforeman-foreman-documentation-preview-pr-3634.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
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 Not yet reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@maximiliankolb