Update Quickstart abstract #4205
Merged
Conversation
This file contains hidden or 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
You don't need to know the details of the installer when you start reading the guide.
github-actions
bot
added
Needs tech review
|
The PR preview for dbc4c74 is available at theforeman-foreman-documentation-preview-pr-4205.surge.sh The following output files are affected by this PR: |
aneta-petrova
commented
Aug 29, 2025
Contributor
maximiliankolb
left a comment
maximiliankolb
left a comment
There was a problem hiding this comment.
I made two suggestion on how to shorten the module.
As a user that really only want to get Foreman up and running, I am probably copy&pasting any commands that I see and skip reading the intro anyway. So 👍 on keeping it short.
Member
Author
|
Thanks for all the suggestions so far! After moving the information from the abstract part of the quickstart to the installer procedure in the previous commits, I now made the installer procedure shorter. Can you please re-review? @ekohl @maximiliankolb |
maximiliankolb
added
tech review done
aneta-petrova
added a commit
that referenced
this pull request
Sep 3, 2025
* Move info on installer to section on running the installer You don't need to know the details of the installer when you start reading the guide. * Update Quickstart abstract * Make quickstart installer procedure shorter (cherry picked from commit 568876d)
Member
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.)
This came up during the review of #4203
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
N/A
Contributor checklists
Please cherry-pick my commits into:
Review checklists
Tech review (performed by an Engineer who did not author the PR; can be skipped if tech review is unnecessary):
Style review (by a Technical Writer who did not author the PR):