baremetal: expand baremetal IPI docs to include customizations #2931
Conversation
openshift-ci-robot
added
the
do-not-merge/work-in-progress
openshift-ci-robot
added
the
size/M
stbenjam
force-pushed
the
baremetal-docs
branch
from
fefa15f
to
195a8aa
Compare
stbenjam
changed the title
openshift-ci-robot
removed
the
do-not-merge/work-in-progress
|
This is probably good enough for a first pass, would someone mind taking a look? /assign @abhinavdahiya |
|
Why is this different in structure and formatting compared to https://github.com/openshift/installer/blob/195a8aa017031966f99331559f2d06a35fedda2d/docs/user/aws/customization.md ?? I would like to see them be similarly formatted. Also can we no create new |
|
I don't like the AWS formatting because we need to group settings together (e.g. here's all the networking-related things you can tweak), and we also need much more prose to describe what it does than AWS documentation conveys in it's simple bulleted list and minimal examples. The AWS examples are also disconnected from the documentation. |
I think the format there should be able to support your list and also provide a way to look at all the fields available.. I don't see how it hinders your "group settings together" or add as much prose your need with the examples. |
|
Can you clarify the complaint? This is awfully nitpicky. It uses the same title format as AWS, and we don't have machine-pool scoped parameters. Do you want another layer of headers that clarifies these are all Cluster-scoped properties? I absolutely want examples in-line with the text, and the grouping as I've written it. |
|
I'll push an update in a minute with a few formatting changes that make it look closer to AWS, but I don't think it needs to be exact... |
stbenjam
force-pushed
the
baremetal-docs
branch
2 times, most recently
from
b0727ef
to
b8ebcc7
Compare
|
PTAL, I've updated the formatting. |
The platform now has a bunch of optional possible customizations, this expands the documentation to follow the other platforms by including a customization.md that details each of the options and why you might want to use them.
stbenjam
force-pushed
the
baremetal-docs
branch
from
b8ebcc7
to
b598970
Compare
Sure, if you must. /approve |
abhinavdahiya
added
the
bugzilla/valid-bug
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: abhinavdahiya The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci-robot
added
the
approved
|
/retest Please review the full test history for this PR and help us cut down flakes. |
4 similar comments
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
5 similar comments
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
/retest Please review the full test history for this PR and help us cut down flakes. |
|
@stbenjam: The following tests failed, say
Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
The platform now has a bunch of optional possible customizations, this
expands the documentation to follow the other platforms by including a
customization.md that details each of the options and why you might want
to use them.