Skip to content
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

Merged
merged 1 commit into from
Jan 18, 2016
Merged

Minor documentation formatting cleanup. #15353

merged 1 commit into from
Jan 18, 2016

Conversation

tpounds
Copy link
Contributor

@tpounds tpounds commented Oct 9, 2015

Formatting improvements to the scratch doc's networking section.

@k8s-bot
Copy link

k8s-bot commented Oct 9, 2015

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.

@k8s-github-robot
Copy link

Labelling this PR as size/S

@k8s-github-robot k8s-github-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 9, 2015
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`
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Member

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

@ashcrow
Copy link
Contributor

ashcrow commented Oct 9, 2015

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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/clusters/node's/ ?

@k8s-bot
Copy link

k8s-bot commented Dec 19, 2015

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.

@thockin thockin added ok-to-merge lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Jan 18, 2016
@thockin thockin closed this Jan 18, 2016
@thockin thockin reopened this Jan 18, 2016
@k8s-github-robot
Copy link

@k8s-bot ok to test
@k8s-bot test this

pr builder appears to be missing, activating due to 'lgtm' label.

@thockin
Copy link
Member

thockin commented Jan 18, 2016

Manually merging because I can't get shippable status to go away

thockin added a commit that referenced this pull request Jan 18, 2016
@thockin thockin merged commit 1a5bd79 into kubernetes:master Jan 18, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants