-
Notifications
You must be signed in to change notification settings - Fork 40k
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
Minor documentation formatting cleanup. #15353
Minor documentation formatting cleanup. #15353
Conversation
Can one of the admins verify that this patch is reasonable to test? (reply "ok to test", or if you trust the user, reply "add to whitelist") If this message is too spammy, please complain to ixdy. |
Labelling this PR as size/S |
1. Add the clusters network to the bridge (docker will go on other side of bridge). | ||
- e.g. `ip addr add $NODE_X_BRIDGE_ADDR dev cbr0` | ||
- `ip addr add $NODE_X_BRIDGE_ADDR dev cbr0` |
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.
nit: Maybe say $YOUR_NODE_X_BRIDGE_ADDR
or another way of telling the user that it's not some automatically created environment variable. I think most people would figure it out upon initial reading but without the e.g. for this line I could see some people misunderstanding.
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.
Sounds reasonable to me. FWIW, $NODE_X_BRIDGE_ADDR
is mentioned in the preceding paragraph so that would need to be changed as well for consistency.
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 don't think YOUR adds much here. If you want to change this I would say THIS_NODE_BRIDGE_ADDR
One nit noted. The changes make sense. |
- `ip link set dev cbr0 mtu 1460` (NOTE: the actual value of MTU will depend on your network environment) | ||
- `brctl addbr cbr0`. | ||
1. Set appropriate MTU. NOTE: the actual value of MTU will depend on your network environment | ||
- `ip link set dev cbr0 mtu 1460` | ||
1. Add the clusters network to the bridge (docker will go on other side of bridge). |
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.
s/clusters/node's/ ?
Can one of the admins verify that this patch is reasonable to test? (reply "ok to test", or if you trust the user, reply "add to whitelist") If this message is too spammy, please complain to ixdy. |
Manually merging because I can't get shippable status to go away |
Minor documentation formatting cleanup.
Formatting improvements to the scratch doc's networking section.