-
Notifications
You must be signed in to change notification settings - Fork 130
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.
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
Refs #29830 - Move discovery plugin docs to RDOC and split out advanced parameters #626
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that as long as we are making these changes, we could improve the documentation of these parameters a bit.
# | ||
# $tftp_root:: tftp root to install image into | ||
# | ||
# $source_url:: source URL to download from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Outside the scope of this PR, but:
I'd argue that this should in fact refer to the full URL of the file. I don't see the use case for having 2 separate parameters and simply concatenating them. It maybe makes our job a little easier as we refer to the $image_name
separately for example at
} ~> exec { "untar ${image_name}": |
$source_url
and $image_name
combined to a single parameter I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I disagree. For example, you mirror it somewhere and only change the base URL while still using the same imagine name as upstream. Another example could be branding where you change the source URL to your company name. It also makes the code a lot harder because now you need to split some URL. That's always painful and a good source of bugs. Given these are advanced parameters, I wouldn't change this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this refer to https://projects.theforeman.org/issues/29830?
08d1d8a
to
db2aa79
Compare
db2aa79
to
80c3a8a
Compare
No description provided.