-
Notifications
You must be signed in to change notification settings - Fork 1.8k
updating codeblocks for the rest of the installation files #24611
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
updating codeblocks for the rest of the installation files #24611
Conversation
The preview will be available shortly at: |
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.
Looks good. Just a few comments.
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.
Is there a reason why this one doesn't start with "export"? I think it should be:
$ export REMOVABLE_MEDIA_PATH=<path>
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.
@wking, is there a reason that we're not exporting the flash drive path when you mirror install/update content?
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 still think we should only export
variables that need to be consumed by sub-processes, and not the rest of these local placeholders (#22008).
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 agree. That makes sense. I just wasn't sure why the one variable was different than the others.
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.
It is correct to break this into two steps. However, you should cut "Generate the thumbprint." and start the step with: "Install the clevis package, if it is not already installed:" Notice that I added the "if" which was missing.
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.
The "Generate a thumbprint..." step should be step "5." and not "a."
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 understand why input and output are being separated in our new style. However, the challenge here is that the "Example output" is a mix of input and output. So the "y" after the words "Do you wish to trust..." is actually something the user types.
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.
You did a good job separating the input from the output. However, I have a question about how the highlighting is supposed to work. Everything from (cat <<EOM
to ) | base64 -w0
is actually typed. But the color highlighting shows the text color as being the same as the output. That applies to other cat <<
examples in the text below as well.
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.
Harder to copy/past, but you could add leading >
as a common continuation prompt ($PS2
). Or have the input highlighted as a shell script instead of a terminal session and remove all the prompts.
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.
@jboxman, will you PTAL at this styling?
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.
Same issue I noted before about cat <<EOF
examples are input all the way down to the last EOF
. But the text after the first line all appears grey, so it looks like output.
a7e1f18
to
c6e2900
Compare
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.
@wking, will you PTAL?
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.
One note where the output looked odd, otherwise lgtm
c6e2900
to
75260a4
Compare
75260a4
to
82d8532
Compare
/cherrypick enterprise-4.5 |
/cherrypick enterprise-4.6 |
@kalexand-rh: new pull request created: #24794 In response to this:
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. |
@kalexand-rh: new pull request created: #24795 In response to this:
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. |
No description provided.